SIRCLO Store Public API V2 API Reference
Welcome to SIRCLO Store Public API v2 Documentation. This is a Graphql Public API for your store v2 website, You can used this graphQL API to connect to SIRCLO Store Platform.
The SIRCLO Store Public API is GraphQL API. It's schema can be fetched using introspection query, you can test the queries and mutations with click Try it now.
The GraphQL endpoints able to access publicly for accessible information such as those publicly for displayed on websites (e.g., product catalog, navigation, banner) and using Authentication for mutations and private information.
API Endpoints
Test Server:
http://puripuri000.sirclo.me.dmmy.me/graphql
Terms of Service: http://puripuri000.sirclo.me.dmmy.me/graphql
Contact: irna@sirclo.com
Version: 1.0.0
Authentication
api_key
API Key url : https://accounts.sirclo.id/token
This endpoint is used to authenticate an API key pair. The pair can be retrieved from admin profile, API key section.
However, this key pair is not usable at this moment, you have to retrieve an access token from this endpoint using the following request:
--location --request POST 'https://accounts.sirclo.id/token' \
--header 'Authorization: Basic NjNFMHdPbDVmaTkyNU9WejdzVHAwWlJUQlV3VkpiSEM6Qm42TDNwVnpkYzZnQ0tWYXNmMXZ2VzNLSUEzdmE4cVI2Qks5WDBKVlNCNXBzWm1VTzBRaFVWTWNyN2sxZEZkMA==' \
--form 'grant_type="client_credentials"'
The authorization header is computed by taking the base64 representation of “{client_id}:{client_secret}”. The request will return an access token that can be used to query our GraphQL .
{
"access_token": "Y494ZIggwIaIHPNDP_ShgUltIj-eziIXt-WpWvGL7vs.paI-A_R0H0KGZIjLEl6niro2vE5Zvyq0H1_H-A-mu6c",
"expires_in": 86399,
"scope": "",
"token_type": "bearer"
}
Note: That the access token only valid for 24 hours, you have to get a new access token to continue using our GraphQL
type
apiKey
name
API Key Authentication
Invalid Token
url: https://accounts.sirclo.id/logout
This endpoint is used to invalidate a token that is no longer used.
--location --request POST 'https://accounts.sirclo.id/logout' \
--header 'Authorization: Basic NjNFMHdPbDVmaTkyNU9WejdzVHAwWlJUQlV3VkpiSEM6Qm42TDNwVnpkYzZnQ0tWYXNmMXZ2VzNLSUEzdmE4cVI2Qks5WDBKVlNCNXBzWm1VTzBRaFVWTWNyN2sxZEZkMA==' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'token=Y494ZIggwIaIHPNDP_ShgUltIj-eziIXt-WpWvGL7vs.paI-A_R0H0KGZIjLEl6niro2vE5Zvyq0H1_H-A-mu6c' \
--data-urlencode 'token_type=bearer'
The authorization header is computed by taking the base64 representation of “{client_id}:{client_secret}”. And the token body is the token you wish to invalidate.
Introspect
url: https://accounts.sirclo.id/introspect
This endpoint is used to introspect a token
--location --request POST 'https://accounts.sirclo.id/introspect' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'token=Am49L8A92_9868mgN7y7WZsO0x9QafKXYtqgJW5fPqw.vY9CFUjyn2z5GQY3cVCRtoo-2YTVPV65CPsQRwOjE-8'
Currently Internal use only
Login admin
Get Access Token
This endpoint used to get accesstoken token to allow an application to access an API
Access Token
Base method to query account by access tooken
token:
string
(no description)
Example
Request Content-Types:
application/json
Query
query accessToken($token: String!){
accessToken(token: $token){
accountID
accessToken
tenantID
allowedActions
isAdmin
}
}
Variables
{
"token": "string"
}
query accessToken($token: String!){
accessToken(token: $token){
accountID
accessToken
tenantID
allowedActions
isAdmin
}
}
{
"token": "string"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"accessToken": {
"accountID": "string",
"accessToken": "string",
"tenantID": "string",
"allowedActions": [
"string"
],
"isAdmin": "boolean"
}
}
}
Fetch Tenant information
Base methods to fetch tenant information.
Fetch tenant
Query tenant information with given id
ID:
string
(no description)
Example
Request Content-Types:
application/json
Query
query tenant($ID: ID){
tenant(ID: $ID){
ID
name
language
currencyCode
}
}
Variables
{
"ID": "string"
}
query tenant($ID: ID){
tenant(ID: $ID){
ID
name
language
currencyCode
}
}
{
"ID": "string"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"tenant": {
"ID": "string",
"name": "string",
"language": "string",
"currencyCode": "string"
}
}
}
Fetch brands Information
This endpoint used to fetch brand
Fetch brand
Qeury brands information
IDs:
string[]
(no description)
Example
Request Content-Types:
application/json
Query
query brands($IDs: [ID!]){
brands(IDs: $IDs){
ID
name
tenantID
logoURL
validCoupons(memberID: $memberID, memberLevel: $memberLevel, items: $items, shippingMethod: $shippingMethod, paymentMethod: $paymentMethod, couponIDs: $couponIDs, date: $date, totalCost: $totalCost)
isExpired
fqdn
googleAdsWebsiteMetaToken
googleAccountLoginURL(redirectURL: $redirectURL)
googleAdsEligibilityStatus
}
}
Variables
{
"IDs": [
"string"
]
}
query brands($IDs: [ID!]){
brands(IDs: $IDs){
ID
name
tenantID
logoURL
validCoupons(memberID: $memberID, memberLevel: $memberLevel, items: $items, shippingMethod: $shippingMethod, paymentMethod: $paymentMethod, couponIDs: $couponIDs, date: $date, totalCost: $totalCost)
isExpired
fqdn
googleAdsWebsiteMetaToken
googleAccountLoginURL(redirectURL: $redirectURL)
googleAdsEligibilityStatus
}
}
{
"IDs": [
"string"
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"brands": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"logoURL": "string",
"validCoupons": [
null
],
"isExpired": "boolean",
"fqdn": "string",
"googleAdsWebsiteMetaToken": "string",
"googleAccountLoginURL": "string",
"googleAdsEligibilityStatus": "integer"
}
]
}
}
Fetch Orders Information
Base method to fetch Orders Information
Fetch Order
Query Single Order Information
token:
string
(no description)
Example
Request Content-Types:
application/json
Query
query order($token: String!){
order(token: $token){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
Variables
{
"token": "string"
}
query order($token: String!){
order(token: $token){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
{
"token": "string"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"order": {
"ID": "string",
"brandID": "string",
"channelID": "string",
"invoiceID": "string",
"createdAt": "integer",
"updatedAt": "integer",
"paymentStatus": "string",
"memberID": "string",
"buyerNote": "string",
"paymentLinks": [
"string"
]
}
}
}
Fetch Orders
Query Orders Information
IDs:
string[]
(no description)
Example
Request Content-Types:
application/json
Query
query orders($IDs: [ID!]!){
orders(IDs: $IDs){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
Variables
{
"IDs": [
"string"
]
}
query orders($IDs: [ID!]!){
orders(IDs: $IDs){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
{
"IDs": [
"string"
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"orders": [
{
"ID": "string",
"brandID": "string",
"channelID": "string",
"invoiceID": "string",
"createdAt": "integer",
"updatedAt": "integer",
"paymentStatus": "string",
"memberID": "string",
"buyerNote": "string",
"paymentLinks": [
"string"
]
}
]
}
}
Fetch Transaction
Query Order by given Transaction ID
ID:
string
(no description)
Example
Request Content-Types:
application/json
Query
query transaction($ID: ID!){
transaction(ID: $ID){
ID
paymentLink
}
}
Variables
{
"ID": "string"
}
query transaction($ID: ID!){
transaction(ID: $ID){
ID
paymentLink
}
}
{
"ID": "string"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"transaction": {
"ID": "string",
"paymentLink": "string"
}
}
}
Fetch Members Information
Base method to fetch members Information
Fetch Members
Query members Information
IDs:
string[]
(no description)
isAdmin:
boolean
(no description)
Example
Request Content-Types:
application/json
Query
query members($IDs: [ID!], $isAdmin: Boolean!){
members(IDs: $IDs, isAdmin: $isAdmin){
accountID
ID
email
firstName
lastName
gender
phone
dateOfBirth
createdAt
updatedAt
level
haveAccessTo(specs: $specs)
}
}
Variables
{
"IDs": [
"string"
],
"isAdmin": "boolean"
}
query members($IDs: [ID!], $isAdmin: Boolean!){
members(IDs: $IDs, isAdmin: $isAdmin){
accountID
ID
email
firstName
lastName
gender
phone
dateOfBirth
createdAt
updatedAt
level
haveAccessTo(specs: $specs)
}
}
{
"IDs": [
"string"
],
"isAdmin": "boolean"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"members": [
{
"accountID": "string",
"ID": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"phone": "string",
"dateOfBirth": "integer",
"createdAt": "integer",
"updatedAt": "integer",
"level": "string",
"haveAccessTo": "boolean"
}
]
}
}
Fetch Products Information
Base method Products Information
Products
Query Products Information
IDs:
string[]
(no description)
Example
Request Content-Types:
application/json
Query
query products($IDs: [ID!]!){
products(IDs: $IDs){
ID
brandID
relatedProductIDs
slug
published
imageURLs
condition
tagKeys
collectionIDs
schedulePublishAt
scheduleOpenOrderAt
scheduleCloseOrderAt
syncStatus
}
}
Variables
{
"IDs": [
"string"
]
}
query products($IDs: [ID!]!){
products(IDs: $IDs){
ID
brandID
relatedProductIDs
slug
published
imageURLs
condition
tagKeys
collectionIDs
schedulePublishAt
scheduleOpenOrderAt
scheduleCloseOrderAt
syncStatus
}
}
{
"IDs": [
"string"
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"products": [
{
"ID": "string",
"brandID": "string",
"relatedProductIDs": [
"string"
],
"slug": "string",
"published": "boolean",
"imageURLs": [
"string"
],
"condition": "string",
"tagKeys": [
"string"
],
"collectionIDs": [
"string"
],
"schedulePublishAt": "integer",
"scheduleOpenOrderAt": "integer",
"scheduleCloseOrderAt": "integer"
}
]
}
}
Product Reviews
Query Product Reviews Information
IDs:
string[]
(no description)
Example
Request Content-Types:
application/json
Query
query productReviews($IDs: [ID!]!){
productReviews(IDs: $IDs){
ID
brandID
orderID
orderCompletedAt
productID
rating
review
imageURLs
videoURLs
reviewerName
reviewerEmail
customerID
createdByAdmin
submittedAt
status
}
}
Variables
{
"IDs": [
"string"
]
}
query productReviews($IDs: [ID!]!){
productReviews(IDs: $IDs){
ID
brandID
orderID
orderCompletedAt
productID
rating
review
imageURLs
videoURLs
reviewerName
reviewerEmail
customerID
createdByAdmin
submittedAt
status
}
}
{
"IDs": [
"string"
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"productReviews": [
{
"ID": "string",
"brandID": "string",
"orderID": "string",
"orderCompletedAt": "integer",
"productID": "string",
"rating": "integer",
"review": "string",
"imageURLs": [
"string"
],
"videoURLs": [
"string"
],
"reviewerName": "string",
"reviewerEmail": "string",
"customerID": "string",
"createdByAdmin": "boolean",
"submittedAt": "integer"
}
]
}
}
Fetch Article Information
Base method to fetch article Information
Fetch Article
Query article Information
IDs:
string[]
(no description)
Example
Request Content-Types:
application/json
Query
query articles($IDs: [ID!]!){
articles(IDs: $IDs){
ID
articleID
categoryID
slug
isActive
}
}
Variables
{
"IDs": [
"string"
]
}
query articles($IDs: [ID!]!){
articles(IDs: $IDs){
ID
articleID
categoryID
slug
isActive
}
}
{
"IDs": [
"string"
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"articles": [
{
"ID": "string",
"articleID": "string",
"categoryID": "string",
"slug": "string",
"isActive": "boolean"
}
]
}
}
Notification Information
Base method to fetch notification Information
Notification Templates
Query fetch templates related to notification service
IDs:
string[]
(no description)
Example
Request Content-Types:
application/json
Query
query notificationTemplates($IDs: [ID!]!){
notificationTemplates(IDs: $IDs){
ID
type
version
isActive
}
}
Variables
{
"IDs": [
"string"
]
}
query notificationTemplates($IDs: [ID!]!){
notificationTemplates(IDs: $IDs){
ID
type
version
isActive
}
}
{
"IDs": [
"string"
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"notificationTemplates": [
{
"ID": "string",
"version": "string",
"isActive": "boolean"
}
]
}
}
Notification Templates V2
Query fetch templates related to notification service
IDs:
string[]
(no description)
Example
Request Content-Types:
application/json
Query
query notificationTemplatesV2($IDs: [ID!]!){
notificationTemplatesV2(IDs: $IDs){
ID
}
}
Variables
{
"IDs": [
"string"
]
}
query notificationTemplatesV2($IDs: [ID!]!){
notificationTemplatesV2(IDs: $IDs){
ID
}
}
{
"IDs": [
"string"
]
}
200 OK
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"notificationTemplatesV2": [
{
"ID": "string"
}
]
}
}
Notification Event Variables
query event variables from eventType related to notification service
input:
(no description)
Example
Request Content-Types:
application/json
Query
query notificationEventVariables($input: NotificationEventInput!){
notificationEventVariables(input: $input)
}
Variables
{
"input": {
"type": "string",
"version": "number"
}
}
query notificationEventVariables($input: NotificationEventInput!){
notificationEventVariables(input: $input)
}
{
"input": {
"type": "string",
"version": "number"
}
}
200 OK
Successful operation
type
object
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {}
}
Notification Event Specs
query event event specifications related to notification service
Example
Request Content-Types:
application/json
Query
query notificationEventSpecs{
notificationEventSpecs{
}
}
query notificationEventSpecs{
notificationEventSpecs{
}
}
200 OK
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"notificationEventSpecs": {}
}
}
Fetch Coupons Information
Base method to fetch coupons Information
Coupons Information
query coupons
IDs:
string[]
(no description)
Example
Request Content-Types:
application/json
Query
query coupons($IDs: [ID!]){
coupons(IDs: $IDs)
}
Variables
{
"IDs": [
"string"
]
}
query coupons($IDs: [ID!]){
coupons(IDs: $IDs)
}
{
"IDs": [
"string"
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"coupons": [
null
]
}
}
Fetch lookbooks Information
Base method to fetch lookbook Information
lookbooks Information
query lookbooks
IDs:
string[]
(no description)
Example
Request Content-Types:
application/json
Query
query lookbooks($IDs: [ID!]!){
lookbooks(IDs: $IDs){
ID
brandID
imageURL
name
isActive
slug
}
}
Variables
{
"IDs": [
"string"
]
}
query lookbooks($IDs: [ID!]!){
lookbooks(IDs: $IDs){
ID
brandID
imageURL
name
isActive
slug
}
}
{
"IDs": [
"string"
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"lookbooks": [
{
"ID": "string",
"brandID": "string",
"imageURL": "string",
"name": "string",
"isActive": "boolean",
"slug": "string"
}
]
}
}
Fetch Payment Providers
Base method to fetch Payment Provider Information
payment Provider Information
query payment Provider
IDs:
string[]
(no description)
Example
Request Content-Types:
application/json
Query
query paymentProviders($IDs: [ID!]){
paymentProviders(IDs: $IDs){
ID
name
logo
}
}
Variables
{
"IDs": [
"string"
]
}
query paymentProviders($IDs: [ID!]){
paymentProviders(IDs: $IDs){
ID
name
logo
}
}
{
"IDs": [
"string"
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"paymentProviders": [
null
]
}
}
Fetch Banner Information
Base method banner Information
Fetch Discounts Information
Base method to fetch discount Information
Discount Information
Discount banner
IDs:
string[]
(no description)
Example
Request Content-Types:
application/json
Query
query discounts($IDs: [ID!]!){
discounts(IDs: $IDs){
brandID
discountID
channelIDs
title
}
}
Variables
{
"IDs": [
"string"
]
}
query discounts($IDs: [ID!]!){
discounts(IDs: $IDs){
brandID
discountID
channelIDs
title
}
}
{
"IDs": [
"string"
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"discounts": [
{
"brandID": "string",
"discountID": "string",
"channelIDs": [
"string"
],
"title": "string"
}
]
}
}
Fetch Navigation Information
Base method Navigantion Information
Fetch Testimonial Information
Base method Testimonial Information
Testimonial Information
Testimonial
IDs:
string[]
(no description)
Example
Request Content-Types:
application/json
Query
query testimonials($IDs: [ID!]!){
testimonials(IDs: $IDs){
ID
brandID
email
author
company
website
memberID
productID
title
content
imageURLs
rating
createdAt
updatedAt
published
isFeatured
}
}
Variables
{
"IDs": [
"string"
]
}
query testimonials($IDs: [ID!]!){
testimonials(IDs: $IDs){
ID
brandID
email
author
company
website
memberID
productID
title
content
imageURLs
rating
createdAt
updatedAt
published
isFeatured
}
}
{
"IDs": [
"string"
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"testimonials": [
{
"ID": "string",
"brandID": "string",
"email": "string",
"author": "string",
"company": "string",
"website": "string",
"memberID": "string",
"productID": "string",
"title": "string",
"content": "string",
"imageURLs": [
"string"
],
"rating": "integer",
"createdAt": "integer",
"updatedAt": "integer",
"published": "boolean",
"isFeatured": "boolean"
}
]
}
}
Fetch Widget Information
Base method Widget Information
Widget Information
Widget
ID:
string
(no description)
Example
Request Content-Types:
application/json
Query
query widget($ID: ID!){
widget(ID: $ID){
ID
name
region
order
content
published
}
}
Variables
{
"ID": "string"
}
query widget($ID: ID!){
widget(ID: $ID){
ID
name
region
order
content
published
}
}
{
"ID": "string"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"widget": {
"ID": "string",
"name": "string",
"region": "string",
"order": "integer",
"content": "string",
"published": "boolean"
}
}
}
Shipping Information
Base method shipping Information
Shipping Information
shipping
ID:
string
(no description)
Example
Request Content-Types:
application/json
Query
query shipping($ID: ID!){
shipping(ID: $ID){
brandID
ID
provider
isActive
}
}
Variables
{
"ID": "string"
}
query shipping($ID: ID!){
shipping(ID: $ID){
brandID
ID
provider
isActive
}
}
{
"ID": "string"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"shipping": {
"brandID": "string",
"ID": "string",
"provider": "string",
"isActive": "boolean"
}
}
}
Billing Information
Base method shipping Information
BIlling Information
billing
Example
Request Content-Types:
application/json
Query
query billing{
billing{
}
}
query billing{
billing{
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"billing": {}
}
}
Get List Allowed Action
Base method List Allowed Actions that can be done
Allowed Actions
Query Get LIst Allowed Action
Example
Request Content-Types:
application/json
Query
query allowedActions{
allowedActions
}
query allowedActions{
allowedActions
}
200 OK
Successful operation
type
string[]
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"allowedActions": [
"string"
]
}
}
Admin of Profile
Base method List of Admin Profile
Admin
Query Profile of an admin
ID:
string
(no description)
Example
Request Content-Types:
application/json
Query
query admin($ID: ID!){
admin(ID: $ID){
ID
firstName
lastName
email
phone
passwordIsSet
lastLogin
role
}
}
Variables
{
"ID": "string"
}
query admin($ID: ID!){
admin(ID: $ID){
ID
firstName
lastName
email
phone
passwordIsSet
lastLogin
role
}
}
{
"ID": "string"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"admin": {
"ID": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"passwordIsSet": "boolean",
"lastLogin": "integer",
"role": "string"
}
}
}
Actions
Base method to query module actions
Actions
Query of module actions
Example
Request Content-Types:
application/json
Query
query actions{
actions{
label
key
}
}
query actions{
actions{
label
key
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"actions": [
{
"label": "string",
"key": "string"
}
]
}
}
Get Export File URL
Base method to query get export file url
export File URL
Query to get export file url
jobID:
string
(no description)
Example
Request Content-Types:
application/json
Query
query exportFileURL($jobID: ID!){
exportFileURL(jobID: $jobID){
url
}
}
Variables
{
"jobID": "string"
}
query exportFileURL($jobID: ID!){
exportFileURL(jobID: $jobID){
url
}
}
{
"jobID": "string"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"exportFileURL": {
"url": "string"
}
}
}
Get Import Status
Base method to query get import status
Import Status
Query to get import status
jobID:
string
(no description)
Example
Request Content-Types:
application/json
Query
query importStatus($jobID: ID!){
importStatus(jobID: $jobID){
importStatus
}
}
Variables
{
"jobID": "string"
}
query importStatus($jobID: ID!){
importStatus(jobID: $jobID){
importStatus
}
}
{
"jobID": "string"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"importStatus": {
"importStatus": "string"
}
}
}
Get Exim History
Base method to query get exim History
Exim History
Query to get exim history
IDs:
string[]
(no description)
Example
Request Content-Types:
application/json
Query
query eximHistory($IDs: [ID!]!){
eximHistory(IDs: $IDs){
ID
brandID
jobID
fileName
fileURL
email
channel
percentProgress
recordCount
uploadedAt
}
}
Variables
{
"IDs": [
"string"
]
}
query eximHistory($IDs: [ID!]!){
eximHistory(IDs: $IDs){
ID
brandID
jobID
fileName
fileURL
email
channel
percentProgress
recordCount
uploadedAt
}
}
{
"IDs": [
"string"
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"eximHistory": [
{
"ID": "string",
"brandID": "string",
"jobID": "string",
"fileName": "string",
"fileURL": "string",
"email": "string",
"channel": "string",
"percentProgress": "integer",
"recordCount": "integer",
"uploadedAt": "integer"
}
]
}
}
News Letters
Base method to get news letters information
News Letters
Query to get exim news letters
IDs:
string[]
(no description)
Example
Request Content-Types:
application/json
Query
query newsletters($IDs: [ID!]!){
newsletters(IDs: $IDs){
ID
brandID
email
createdAt
}
}
Variables
{
"IDs": [
"string"
]
}
query newsletters($IDs: [ID!]!){
newsletters(IDs: $IDs){
ID
brandID
email
createdAt
}
}
{
"IDs": [
"string"
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"newsletters": [
{
"ID": "string",
"brandID": "string",
"email": "string",
"createdAt": "integer"
}
]
}
}
Get Validate Setting
Base method to get validate setting
Validate Setting
Query to get validate Setting
input:
(no description)
Example
Request Content-Types:
application/json
Query
query validateSetting($input: ValidateSettingInput!){
validateSetting(input: $input){
}
}
Variables
{
"input": {
"adminEmail": "string",
"bankAccount": {
"banks": [
{
"name": "string",
"accountNumber": "string",
"accountName": "string",
"isActive": "boolean"
}
]
},
"checkoutAsGuestEnabled": "boolean",
"confirmPaymentMessage": {
"isActive": "boolean",
"message": "string"
},
"faviconURL": "string",
"hideFromSearchEngine": "boolean",
"newsletter": {
"popupOnFirstVisit": "boolean",
"content": "string"
},
"paymentMethods": {
"paymentMethods": [
{
"name": "string",
"merchantID": "string",
"clientKey": "string",
"serverKey": "string",
"acquiringBank": "string",
"payPalAccount": "string",
"specs": [
{
"method": "string",
"isActive": "boolean",
"chargeFeeToCustomer": "boolean",
"expiryHour": "number"
}
]
}
]
},
"productFilterAndSort": {
"filters": [
{
"name": "string",
"isActive": "boolean",
"type": "string",
"variantSpecs": [
{
"key": "string",
"translations": [
{
"language": "string",
"text": "string"
}
],
"options": [
{
"value": "string",
"translations": [
{
"language": "string",
"text": "string"
}
]
}
]
}
]
}
]
}
}
}
query validateSetting($input: ValidateSettingInput!){
validateSetting(input: $input){
}
}
{
"input": {
"adminEmail": "string",
"bankAccount": {
"banks": [
{
"name": "string",
"accountNumber": "string",
"accountName": "string",
"isActive": "boolean"
}
]
},
"checkoutAsGuestEnabled": "boolean",
"confirmPaymentMessage": {
"isActive": "boolean",
"message": "string"
},
"faviconURL": "string",
"hideFromSearchEngine": "boolean",
"newsletter": {
"popupOnFirstVisit": "boolean",
"content": "string"
},
"paymentMethods": {
"paymentMethods": [
{
"name": "string",
"merchantID": "string",
"clientKey": "string",
"serverKey": "string",
"acquiringBank": "string",
"payPalAccount": "string",
"specs": [
{
"method": "string",
"isActive": "boolean",
"chargeFeeToCustomer": "boolean",
"expiryHour": "number"
}
]
}
]
},
"productFilterAndSort": {
"filters": [
{
"name": "string",
"isActive": "boolean",
"type": "string",
"variantSpecs": [
{
"key": "string",
"translations": [
{
"language": "string",
"text": "string"
}
],
"options": [
{
"value": "string",
"translations": [
{
"language": "string",
"text": "string"
}
]
}
]
}
]
}
]
}
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"validateSetting": {}
}
}
Get Instagram Feeds
Base method to get instagram feeds
Instagram Feeds
Query to get instagram Feeds
input:
(no description)
Example
Request Content-Types:
application/json
Query
query instagramFeeds($input: InstagramFeedsInput!){
instagramFeeds(input: $input){
}
}
Variables
{
"input": {
"ID": "object",
"first": "number",
"after": "string"
}
}
query instagramFeeds($input: InstagramFeedsInput!){
instagramFeeds(input: $input){
}
}
{
"input": {
"ID": "object",
"first": "number",
"after": "string"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"instagramFeeds": {}
}
}
Get List Documents
Base method to get List Documents
Documents
Query to get list Documents
input:
(no description)
Example
Request Content-Types:
application/json
Query
query documents($input: DocumentsInput!){
documents(input: $input){
}
}
Variables
{
"input": {
"brandIDs": [
"object"
],
"filter": {
"name": "string",
"status": "string",
"token": "string",
"signerID": "string"
},
"sort": [
{
"fieldName": "string",
"isAscending": "boolean"
}
],
"page": {
"pageNumber": "number",
"itemPerPage": "number"
}
}
}
query documents($input: DocumentsInput!){
documents(input: $input){
}
}
{
"input": {
"brandIDs": [
"object"
],
"filter": {
"name": "string",
"status": "string",
"token": "string",
"signerID": "string"
},
"sort": [
{
"fieldName": "string",
"isAscending": "boolean"
}
],
"page": {
"pageNumber": "number",
"itemPerPage": "number"
}
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"documents": {}
}
}
Check signer Identify
Base method to check signer identity
Identity
Query to check signer identity
input:
(no description)
Example
Request Content-Types:
application/json
Query
query identity($input: IdentityInput!){
identity(input: $input){
signerID
email
phone
status
name
}
}
Variables
{
"input": {
"brandID": "object",
"accessToken": "string"
}
}
query identity($input: IdentityInput!){
identity(input: $input){
signerID
email
phone
status
name
}
}
{
"input": {
"brandID": "object",
"accessToken": "string"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"identity": {
"signerID": "string",
"email": "string",
"phone": "string",
"status": "string",
"name": "string"
}
}
}
List Tenant Exist
Base method to check is tenant already exists
Is Tenant Exist
Query to check if tenant already exists
ID:
string
(no description)
Example
Request Content-Types:
application/json
Query
query isTenantExist($ID: String!){
isTenantExist(ID: $ID)
}
Variables
{
"ID": "string"
}
query isTenantExist($ID: String!){
isTenantExist(ID: $ID)
}
{
"ID": "string"
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"isTenantExist": "boolean"
}
}
List Features
Base method to get list features
Features
Query to get list features
IDs:
string[]
(no description)
Example
Request Content-Types:
application/json
Query
query features($IDs: [ID!]!){
features(IDs: $IDs){
ID
isEnabled
}
}
Variables
{
"IDs": [
"string"
]
}
query features($IDs: [ID!]!){
features(IDs: $IDs){
ID
isEnabled
}
}
{
"IDs": [
"string"
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"features": [
{
"ID": "string",
"isEnabled": "boolean"
}
]
}
}
Bootstrap Brand Task
Base method to get status of brand bootstrapping process
Shipment Tracking
Base method to get status of brand bootstrapping process
Boostrap Brand Task
Query to get the status of brand bootstrapping process
taskID:
string
(no description)
Example
Request Content-Types:
application/json
Query
query bootstrapBrandTask($taskID: String!){
bootstrapBrandTask(taskID: $taskID){
ID
result
}
}
Variables
{
"taskID": "string"
}
query bootstrapBrandTask($taskID: String!){
bootstrapBrandTask(taskID: $taskID){
ID
result
}
}
{
"taskID": "string"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"bootstrapBrandTask": {
"ID": "string"
}
}
}
Get Plan Actions
Base method to get plan actions
Plan Aactions
Query to get plan actions
planIDs:
string[]
(no description)
actions:
string[]
(no description)
Example
Request Content-Types:
application/json
Query
query planActions($planIDs: [ID!]!, $actions: [String!]!){
planActions(planIDs: $planIDs, actions: $actions){
planID
action
}
}
Variables
{
"planIDs": [
"string"
],
"actions": [
"string"
]
}
query planActions($planIDs: [ID!]!, $actions: [String!]!){
planActions(planIDs: $planIDs, actions: $actions){
planID
action
}
}
{
"planIDs": [
"string"
],
"actions": [
"string"
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"planActions": [
{
"planID": "string",
"action": "string",
"parameters": [
null
]
}
]
}
}
Get Escrows
Base method to get escrow Activation Status
Escrows
Query to get escrow activation status
brandIds:
string[]
(no description)
Example
Request Content-Types:
application/json
Query
query escrows($brandIds: [String!]){
escrows(brandIds: $brandIds){
brandID
activatedBy
activatedAt
isActive
}
}
Variables
{
"brandIds": [
"string"
]
}
query escrows($brandIds: [String!]){
escrows(brandIds: $brandIds){
brandID
activatedBy
activatedAt
isActive
}
}
{
"brandIds": [
"string"
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"escrows": [
{
"brandID": "string",
"activatedBy": "string",
"activatedAt": "integer",
"isActive": "boolean"
}
]
}
}
Article Categories
Base method to get article categories
Article Categories
Base method to get article categories
Article Catgories
Query to get article categories
IDs:
string[]
(no description)
Example
Request Content-Types:
application/json
Query
query articleCategories($IDs: [ID!]!){
articleCategories(IDs: $IDs){
categoryID
imageURL
isActive
displayType
slug
}
}
Variables
{
"IDs": [
"string"
]
}
query articleCategories($IDs: [ID!]!){
articleCategories(IDs: $IDs){
categoryID
imageURL
isActive
displayType
slug
}
}
{
"IDs": [
"string"
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"articleCategories": [
{
"categoryID": "string",
"imageURL": "string",
"isActive": "boolean",
"slug": "string"
}
]
}
}
Analytics Setting
Base method to get analytics Setting
Analytics Setting
Query to get analytics Setting
input:
(no description)
Example
Request Content-Types:
application/json
Query
query analyticsSetting($input: AnalyticsSettingInput){
analyticsSetting(input: $input){
}
}
Variables
{
"input": {
"brandId": "string"
}
}
query analyticsSetting($input: AnalyticsSettingInput){
analyticsSetting(input: $input){
}
}
{
"input": {
"brandId": "string"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"analyticsSetting": {}
}
}
List Buyer
Base method to get list buyers
Buyers
Query to get list buyers
brandId:
string
(no description)
param:
string
(no description)
input:
(no description)
Example
Request Content-Types:
application/json
Query
query buyers($brandId: ID, $param: String, $input: BuyersInput){
buyers(brandId: $brandId, param: $param, input: $input){
id
name
channel
isRead
lastMessage
lastAlert
timestamp
type
lastMessageId
isArchived
createdAt
updatedAt
unreadCount
message_id
session
userId
}
}
Variables
{
"brandId": "string",
"param": "string",
"input": {
"sellerId": "object",
"channel": "string",
"scroll": "string",
"id": "string",
"buyerId": "object",
"limit": "number",
"userId": "string",
"show": "string",
"session": "string"
}
}
query buyers($brandId: ID, $param: String, $input: BuyersInput){
buyers(brandId: $brandId, param: $param, input: $input){
id
name
channel
isRead
lastMessage
lastAlert
timestamp
type
lastMessageId
isArchived
createdAt
updatedAt
unreadCount
message_id
session
userId
}
}
{
"brandId": "string",
"param": "string",
"input": {
"sellerId": "object",
"channel": "string",
"scroll": "string",
"id": "string",
"buyerId": "object",
"limit": "number",
"userId": "string",
"show": "string",
"session": "string"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"buyers": [
{
"id": "string",
"name": "string",
"channel": "string",
"isRead": "boolean",
"lastMessage": "string",
"lastAlert": "string",
"timestamp": "integer",
"type": "string",
"lastMessageId": "integer",
"isArchived": "boolean",
"createdAt": "string",
"updatedAt": "string",
"unreadCount": "integer",
"message_id": "string",
"session": "string",
"userId": "string"
}
]
}
}
News Letter Setting
Base method to get news letter Setting
news letter setting
Query to get list buyers
input:
(no description)
Example
Request Content-Types:
application/json
Query
query newsletterSetting($input: newsletterSettingInput!){
newsletterSetting(input: $input){
brandID
}
}
Variables
{
"input": {
"brandID": "string"
}
}
query newsletterSetting($input: newsletterSettingInput!){
newsletterSetting(input: $input){
brandID
}
}
{
"input": {
"brandID": "string"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"newsletterSetting": {
"brandID": "string"
}
}
}
Socmed Setting
Base method to get Socmed Setting
Socmed Setting
Query to get Socmed Setting
input:
(no description)
Example
Request Content-Types:
application/json
Query
query socmedSetting($input: SocmedSettingInput){
socmedSetting(input: $input){
instagramToken
}
}
Variables
{
"input": {
"brandId": "string"
}
}
query socmedSetting($input: SocmedSettingInput){
socmedSetting(input: $input){
instagramToken
}
}
{
"input": {
"brandId": "string"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"socmedSetting": {
"instagramToken": "string"
}
}
}
Links Page
Base method to get Links Page
Links Page
Query to get Links Page
input:
(no description)
Example
Request Content-Types:
application/json
Query
query linkspage($input: LinkspageInput){
linkspage(input: $input){
brandId
backgroundColor
description
hexTextColor
logoImage
name
}
}
Variables
{
"input": {
"brandId": "string"
}
}
query linkspage($input: LinkspageInput){
linkspage(input: $input){
brandId
backgroundColor
description
hexTextColor
logoImage
name
}
}
{
"input": {
"brandId": "string"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"linkspage": {
"brandId": "string",
"backgroundColor": "string",
"description": "string",
"hexTextColor": "string",
"logoImage": "string",
"name": "string"
}
}
}
Site Config
Base method to get Site Config
Site Config
Query to get Site Config
Example
Request Content-Types:
application/json
Query
query siteConfig{
siteConfig{
siteId
host
fqdn
template
}
}
query siteConfig{
siteConfig{
siteId
host
fqdn
template
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"siteConfig": {
"siteId": "string",
"host": "string",
"fqdn": "string",
"template": "string"
}
}
}
Shipping Method
Base method to get shipping methods
Shipping Methods
Query to get Shipping Methods
brandId:
string
(no description)
country:
string
(no description)
city:
string
(no description)
destination:
(no description)
Example
Request Content-Types:
application/json
Query
query shippingMethods($brandId: String!, $country: String, $city: String, $destination: destinationInput){
shippingMethods(brandId: $brandId, country: $country, city: $city, destination: $destination){
provider
service
cost
}
}
Variables
{
"brandId": "string",
"country": "string",
"city": "string",
"destination": {
"districtCode": "string",
"cityCode": "string",
"countryCode": "string"
}
}
query shippingMethods($brandId: String!, $country: String, $city: String, $destination: destinationInput){
shippingMethods(brandId: $brandId, country: $country, city: $city, destination: $destination){
provider
service
cost
}
}
{
"brandId": "string",
"country": "string",
"city": "string",
"destination": {
"districtCode": "string",
"cityCode": "string",
"countryCode": "string"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"shippingMethods": [
{
"provider": "string",
"service": "string",
"cost": "integer"
}
]
}
}
Get Single Message
Base method to get single message
Message
Query to get Message
id:
integer
(no description)
message_id:
string
(no description)
gql_id:
string
(no description)
Example
Request Content-Types:
application/json
Query
query message($id: Int, $message_id: String, $gql_id: String){
message(id: $id, message_id: $message_id, gql_id: $gql_id){
to
from
timestamp
buyer_name
message
id
message_id
gql_id
type
status
context_id
caption
channel
}
}
Variables
{
"id": "integer",
"message_id": "string",
"gql_id": "string"
}
query message($id: Int, $message_id: String, $gql_id: String){
message(id: $id, message_id: $message_id, gql_id: $gql_id){
to
from
timestamp
buyer_name
message
id
message_id
gql_id
type
status
context_id
caption
channel
}
}
{
"id": "integer",
"message_id": "string",
"gql_id": "string"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"message": {
"to": "string",
"from": "string",
"timestamp": "string",
"buyer_name": "string",
"message": "string",
"id": "string",
"message_id": "string",
"gql_id": "string",
"type": "string",
"status": "string",
"context_id": "string",
"caption": "string",
"channel": "string"
}
}
}
Get Messages
Base method to get list messages
Messages
Query to get list Messages
brandId:
string
(no description)
roomID:
string
(no description)
messageID:
integer
(no description)
scroll:
string
(no description)
Example
Request Content-Types:
application/json
Query
query messages($brandId: ID!, $roomID: ID!, $messageID: Int, $scroll: String){
messages(brandId: $brandId, roomID: $roomID, messageID: $messageID, scroll: $scroll){
to
from
timestamp
buyer_name
message
id
message_id
gql_id
type
status
context_id
caption
channel
}
}
Variables
{
"brandId": "string",
"roomID": "string",
"messageID": "integer",
"scroll": "string"
}
query messages($brandId: ID!, $roomID: ID!, $messageID: Int, $scroll: String){
messages(brandId: $brandId, roomID: $roomID, messageID: $messageID, scroll: $scroll){
to
from
timestamp
buyer_name
message
id
message_id
gql_id
type
status
context_id
caption
channel
}
}
{
"brandId": "string",
"roomID": "string",
"messageID": "integer",
"scroll": "string"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"messages": [
{
"to": "string",
"from": "string",
"timestamp": "string",
"buyer_name": "string",
"message": "string",
"id": "string",
"message_id": "string",
"gql_id": "string",
"type": "string",
"status": "string",
"context_id": "string",
"caption": "string",
"channel": "string"
}
]
}
}
Seller
Base method to get seller
Seller
Query to get Seller
email:
string
(no description)
buyersInputShow:
(no description)
Example
Request Content-Types:
application/json
Query
query seller($email: String!, $buyersInputShow: BuyersInputShow){
seller(email: $email, buyersInputShow: $buyersInputShow){
phoneNumber
whatsappNamespace
brandId
email
role
queueCount
buyersInputShow
}
}
Variables
{
"email": "string",
"buyersInputShow": "string"
}
query seller($email: String!, $buyersInputShow: BuyersInputShow){
seller(email: $email, buyersInputShow: $buyersInputShow){
phoneNumber
whatsappNamespace
brandId
email
role
queueCount
buyersInputShow
}
}
{
"email": "string",
"buyersInputShow": "string"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"seller": {
"phoneNumber": "string",
"whatsappNamespace": "string",
"brandId": "string",
"email": "string",
"role": "string",
"queueCount": "integer"
}
}
}
Search
Base method to searc
Search
Query to Search
brandId:
string
(no description)
query:
string
(no description)
Example
Request Content-Types:
application/json
Query
query search($brandId: ID!, $query: String){
search(brandId: $brandId, query: $query){
}
}
Variables
{
"brandId": "string",
"query": "string"
}
query search($brandId: ID!, $query: String){
search(brandId: $brandId, query: $query){
}
}
{
"brandId": "string",
"query": "string"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"search": {}
}
}
Detect Text Intent
Base method detect Text Intent
Detect Text Intent
Query to detect Text Intent
sellerID:
string
(no description)
message:
string
(no description)
brandID:
string
(no description)
buyerID:
string
(no description)
Example
Request Content-Types:
application/json
Query
query detectTextIntent($sellerID: ID!, $message: String!, $brandID: String!, $buyerID: String!){
detectTextIntent(sellerID: $sellerID, message: $message, brandID: $brandID, buyerID: $buyerID){
intent
textResponse
isFinalState
}
}
Variables
{
"sellerID": "string",
"message": "string",
"brandID": "string",
"buyerID": "string"
}
query detectTextIntent($sellerID: ID!, $message: String!, $brandID: String!, $buyerID: String!){
detectTextIntent(sellerID: $sellerID, message: $message, brandID: $brandID, buyerID: $buyerID){
intent
textResponse
isFinalState
}
}
{
"sellerID": "string",
"message": "string",
"brandID": "string",
"buyerID": "string"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"detectTextIntent": {
"intent": "string",
"textResponse": "string",
"isFinalState": "boolean"
}
}
}
Get Airwaybill
Base method to get airwaybills
Airwaybills
Query to get Airwaybills
siteID:
string
(no description)
dataIDs:
integer[]
(no description)
Example
Request Content-Types:
application/json
Query
query airwaybills($siteID: String!, $dataIDs: [Int]!){
airwaybills(siteID: $siteID, dataIDs: $dataIDs){
providerService
customerSMCode
providerName
orderNumber
senderPhone
senderName
awbNumber
orderDate
remarks
smCode
logo
}
}
Variables
{
"siteID": "string",
"dataIDs": [
"integer"
]
}
query airwaybills($siteID: String!, $dataIDs: [Int]!){
airwaybills(siteID: $siteID, dataIDs: $dataIDs){
providerService
customerSMCode
providerName
orderNumber
senderPhone
senderName
awbNumber
orderDate
remarks
smCode
logo
}
}
{
"siteID": "string",
"dataIDs": [
"integer"
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"airwaybills": [
{
"providerService": "string",
"customerSMCode": "string",
"providerName": "string",
"orderNumber": "string",
"senderPhone": "string",
"senderName": "string",
"awbNumber": "string",
"orderDate": "string",
"remarks": "string",
"smCode": "string",
"logo": "string"
}
]
}
}
City Options
Base method to get city district Option
City Options
Query to city District Option
query:
string
(no description)
limit:
integer
(no description)
Example
Request Content-Types:
application/json
Query
query cityOptions($query: String!, $limit: Int!){
cityOptions(query: $query, limit: $limit){
key
value
provinceName
cityName
districtName
}
}
Variables
{
"query": "string",
"limit": "integer"
}
query cityOptions($query: String!, $limit: Int!){
cityOptions(query: $query, limit: $limit){
key
value
provinceName
cityName
districtName
}
}
{
"query": "string",
"limit": "integer"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"cityOptions": [
{
"key": "string",
"value": "string",
"provinceName": "string",
"cityName": "string",
"districtName": "string"
}
]
}
}
City District Option
Base method to get city district Options
City District Options
Query to city District Options
query:
string
(no description)
limit:
integer
(no description)
Example
Request Content-Types:
application/json
Query
query districtOptions($query: String!, $limit: Int!){
districtOptions(query: $query, limit: $limit){
key
value
provinceName
cityName
districtName
}
}
Variables
{
"query": "string",
"limit": "integer"
}
query districtOptions($query: String!, $limit: Int!){
districtOptions(query: $query, limit: $limit){
key
value
provinceName
cityName
districtName
}
}
{
"query": "string",
"limit": "integer"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"districtOptions": [
{
"key": "string",
"value": "string",
"provinceName": "string",
"cityName": "string",
"districtName": "string"
}
]
}
}
List Cart
Base method to get cart
Cart
Query to get list Cart
sellerId:
string
(no description)
buyerId:
string
(no description)
Example
Request Content-Types:
application/json
Query
query cart($sellerId: String!, $buyerId: String!){
cart(sellerId: $sellerId, buyerId: $buyerId){
sellerId
buyerId
}
}
Variables
{
"sellerId": "string",
"buyerId": "string"
}
query cart($sellerId: String!, $buyerId: String!){
cart(sellerId: $sellerId, buyerId: $buyerId){
sellerId
buyerId
}
}
{
"sellerId": "string",
"buyerId": "string"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"cart": {
"sellerId": "string",
"buyerId": "string"
}
}
}
Legacy Payment Methods
Base method to get legacy payment methods
Legacy Payment Methods
Query to get legacy Payment Method
brandId:
string
(no description)
Example
Request Content-Types:
application/json
Query
query legacyPaymentMethods($brandId: String!){
legacyPaymentMethods(brandId: $brandId){
title
value
}
}
Variables
{
"brandId": "string"
}
query legacyPaymentMethods($brandId: String!){
legacyPaymentMethods(brandId: $brandId){
title
value
}
}
{
"brandId": "string"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"legacyPaymentMethods": [
{
"title": "string",
"value": "string"
}
]
}
}
Upsert Member Account
Base method to get member Accountc Upsert
Member Account Upsert
Query to get member account upsert
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation memberAccountUpsert($input: MemberAccountUpsertInput!){
memberAccountUpsert(input: $input){
}
}
Variables
{
"input": {
"firstName": "string",
"lastName": "string",
"email": "string",
"password": "string",
"address": "string",
"country": "string",
"state": "string",
"city": "string",
"zipCode": "string",
"phone": "string",
"dateOfBirth": "object"
}
}
mutation memberAccountUpsert($input: MemberAccountUpsertInput!){
memberAccountUpsert(input: $input){
}
}
{
"input": {
"firstName": "string",
"lastName": "string",
"email": "string",
"password": "string",
"address": "string",
"country": "string",
"state": "string",
"city": "string",
"zipCode": "string",
"phone": "string",
"dateOfBirth": "object"
}
}
200 OK
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"memberAccountUpsert": {}
}
}
Chat setting
This endpoint operation chat Settings
Delete All Chat Setting
mutation to delete chat settings
sellerID:
string
(no description)
Example
Request Content-Types:
application/json
Query
mutation deleteAllChatSettings($sellerID: String!){
deleteAllChatSettings(sellerID: $sellerID)
}
Variables
{
"sellerID": "string"
}
mutation deleteAllChatSettings($sellerID: String!){
deleteAllChatSettings(sellerID: $sellerID)
}
{
"sellerID": "string"
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteAllChatSettings": "boolean"
}
}
Set All Chat Setting
mutation to set chat settings
params:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setAllChatSettings($params: setAllChatSettingsInput!){
setAllChatSettings(params: $params){
sellerId
about
photoUrl
address
description
email
vertical
websites
}
}
Variables
{
"params": {
"sellerId": "string",
"about": "string",
"photoUrl": "string",
"address": "string",
"description": "string",
"email": "string",
"vertical": "string",
"websites": [
"string"
]
}
}
mutation setAllChatSettings($params: setAllChatSettingsInput!){
setAllChatSettings(params: $params){
sellerId
about
photoUrl
address
description
email
vertical
websites
}
}
{
"params": {
"sellerId": "string",
"about": "string",
"photoUrl": "string",
"address": "string",
"description": "string",
"email": "string",
"vertical": "string",
"websites": [
"string"
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setAllChatSettings": {
"sellerId": "string",
"about": "string",
"photoUrl": "string",
"address": "string",
"description": "string",
"email": "string",
"vertical": "string",
"websites": [
"string"
]
}
}
}
Store Operation
This endpoint to operate store in your store
Upsert Store Settings Input
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertStoreSettings($input: upsertStoreSettingsInput!){
upsertStoreSettings(input: $input){
key
value
}
}
Variables
{
"input": {
"sellerId": "string",
"settings": [
{
"key": "string",
"value": "string"
}
]
}
}
mutation upsertStoreSettings($input: upsertStoreSettingsInput!){
upsertStoreSettings(input: $input){
key
value
}
}
{
"input": {
"sellerId": "string",
"settings": [
{
"key": "string",
"value": "string"
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertStoreSettings": [
{
"key": "string",
"value": "string"
}
]
}
}
Change Chatroom Status
This endpoint used to change chat room status on your store
Change chatroom status
Mutation to Change Chatroom Status
brandId:
string
(no description)
buyerID:
string
(no description)
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation changeChatroomStatus($brandId: ID, $buyerID: ID, $input: ChangeChatRoomStatusInput){
changeChatroomStatus(brandId: $brandId, buyerID: $buyerID, input: $input){
id
name
channel
isRead
lastMessage
lastAlert
timestamp
type
lastMessageId
isArchived
createdAt
updatedAt
unreadCount
message_id
session
userId
}
}
Variables
{
"brandId": "string",
"buyerID": "string",
"input": {
"buyerId": "object",
"sellerId": "object"
}
}
mutation changeChatroomStatus($brandId: ID, $buyerID: ID, $input: ChangeChatRoomStatusInput){
changeChatroomStatus(brandId: $brandId, buyerID: $buyerID, input: $input){
id
name
channel
isRead
lastMessage
lastAlert
timestamp
type
lastMessageId
isArchived
createdAt
updatedAt
unreadCount
message_id
session
userId
}
}
{
"brandId": "string",
"buyerID": "string",
"input": {
"buyerId": "object",
"sellerId": "object"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"changeChatroomStatus": {
"id": "string",
"name": "string",
"channel": "string",
"isRead": "boolean",
"lastMessage": "string",
"lastAlert": "string",
"timestamp": "integer",
"type": "string",
"lastMessageId": "integer",
"isArchived": "boolean",
"createdAt": "string",
"updatedAt": "string",
"unreadCount": "integer",
"message_id": "string",
"session": "string",
"userId": "string"
}
}
}
Upsert ChatRoom Attributes
Mutation to Upsert Chatroom Attributes
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertChatRoomAttributes($input: UpsertChatRoomAttributesInput!){
upsertChatRoomAttributes(input: $input){
id
chatRoomId
key
value
}
}
Variables
{
"input": {
"sellerId": "string",
"buyerId": "string",
"attributes": [
{
"key": "string",
"value": "string"
}
]
}
}
mutation upsertChatRoomAttributes($input: UpsertChatRoomAttributesInput!){
upsertChatRoomAttributes(input: $input){
id
chatRoomId
key
value
}
}
{
"input": {
"sellerId": "string",
"buyerId": "string",
"attributes": [
{
"key": "string",
"value": "string"
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertChatRoomAttributes": [
{
"id": "integer",
"chatRoomId": "integer",
"key": "string",
"value": "string"
}
]
}
}
Update Message Template
This endpoint used to upsert message template
Upsert Message Template
Mutation to upsert message template
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertMessageTemplate($input: upsertMessageTemplateInput!){
upsertMessageTemplate(input: $input)
}
Variables
{
"input": {
"sellerId": "string",
"key": "string",
"id": "number",
"value": "string",
"type": "string",
"status": "boolean",
"category": "string",
"attachment": "string",
"attachmentType": "string"
}
}
mutation upsertMessageTemplate($input: upsertMessageTemplateInput!){
upsertMessageTemplate(input: $input)
}
{
"input": {
"sellerId": "string",
"key": "string",
"id": "number",
"value": "string",
"type": "string",
"status": "boolean",
"category": "string",
"attachment": "string",
"attachmentType": "string"
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertMessageTemplate": "boolean"
}
}
Upsert Message Templates
Mutation to Upsert Message template
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertMessageTemplates($input: upsertMessageTemplatesInput!){
upsertMessageTemplates(input: $input){
sellerId
id
key
value
type
status
category
attachment
attachmentType
}
}
Variables
{
"input": {
"sellerId": "string",
"specs": [
{
"sellerId": "string",
"key": "string",
"id": "number",
"value": "string",
"type": "string",
"status": "boolean",
"category": "string",
"attachment": "string",
"attachmentType": "string"
}
]
}
}
mutation upsertMessageTemplates($input: upsertMessageTemplatesInput!){
upsertMessageTemplates(input: $input){
sellerId
id
key
value
type
status
category
attachment
attachmentType
}
}
{
"input": {
"sellerId": "string",
"specs": [
{
"sellerId": "string",
"key": "string",
"id": "number",
"value": "string",
"type": "string",
"status": "boolean",
"category": "string",
"attachment": "string",
"attachmentType": "string"
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertMessageTemplates": [
{
"sellerId": "string",
"id": "integer",
"key": "string",
"value": "string",
"type": "string",
"status": "boolean",
"category": "string",
"attachment": "string",
"attachmentType": "string"
}
]
}
}
Send Message
Mutation to send message
message:
(no description)
Example
Request Content-Types:
application/json
Query
mutation sendMessage($message: messageInput){
sendMessage(message: $message){
to
from
timestamp
buyer_name
message
id
message_id
gql_id
type
status
context_id
caption
channel
}
}
Variables
{
"message": {
"to": "string",
"from": "string",
"timestamp": "string",
"buyer_name": "string",
"message": "string",
"message_id": "object",
"gql_id": "object",
"type": "string",
"status": "string",
"element_name": "string",
"namespace": "string",
"id": "object",
"context_id": "string",
"meta": [
{
"gql_id": "string",
"key": "string",
"value": "string"
}
],
"caption": "string",
"channel": "string"
}
}
mutation sendMessage($message: messageInput){
sendMessage(message: $message){
to
from
timestamp
buyer_name
message
id
message_id
gql_id
type
status
context_id
caption
channel
}
}
{
"message": {
"to": "string",
"from": "string",
"timestamp": "string",
"buyer_name": "string",
"message": "string",
"message_id": "object",
"gql_id": "object",
"type": "string",
"status": "string",
"element_name": "string",
"namespace": "string",
"id": "object",
"context_id": "string",
"meta": [
{
"gql_id": "string",
"key": "string",
"value": "string"
}
],
"caption": "string",
"channel": "string"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"sendMessage": {
"to": "string",
"from": "string",
"timestamp": "string",
"buyer_name": "string",
"message": "string",
"id": "string",
"message_id": "string",
"gql_id": "string",
"type": "string",
"status": "string",
"context_id": "string",
"caption": "string",
"channel": "string"
}
}
}
Delete Message Template
Mutation to delete message template
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation deleteMessageTemplate($input: DeleteMessageTemplateInput!){
deleteMessageTemplate(input: $input)
}
Variables
{
"input": {
"sellerId": "string",
"ids": [
"number"
]
}
}
mutation deleteMessageTemplate($input: DeleteMessageTemplateInput!){
deleteMessageTemplate(input: $input)
}
{
"input": {
"sellerId": "string",
"ids": [
"number"
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteMessageTemplate": "boolean"
}
}
Chat Queue
This endpoint used to calin and close chat queue
Claim Chat Queue
Mutation to claim chat queue
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation claimChatQueue($input: ClaimChatQueueInput!){
claimChatQueue(input: $input){
buyerId
buyerName
channel
isRead
lastMessageId
lastMessage
lastAlert
timestamp
messageType
}
}
Variables
{
"input": {
"userId": "string",
"sellerId": "string"
}
}
mutation claimChatQueue($input: ClaimChatQueueInput!){
claimChatQueue(input: $input){
buyerId
buyerName
channel
isRead
lastMessageId
lastMessage
lastAlert
timestamp
messageType
}
}
{
"input": {
"userId": "string",
"sellerId": "string"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"claimChatQueue": {
"buyerId": "string",
"buyerName": "string",
"channel": "string",
"isRead": "boolean",
"lastMessageId": "integer",
"lastMessage": "string",
"lastAlert": "string",
"timestamp": "integer",
"messageType": "string"
}
}
}
Close Chat Queue
Mutation to close chat queue
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation closeChatQueue($input: CloseChatQueueInput!){
closeChatQueue(input: $input){
sellerId
buyerId
}
}
Variables
{
"input": {
"sellerId": "string",
"buyerId": "string",
"userId": "string"
}
}
mutation closeChatQueue($input: CloseChatQueueInput!){
closeChatQueue(input: $input){
sellerId
buyerId
}
}
{
"input": {
"sellerId": "string",
"buyerId": "string",
"userId": "string"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"closeChatQueue": {
"sellerId": "string",
"buyerId": "string"
}
}
}
Update Buyer Detail
Update Buyer Detail
Mutation for Update Buyer Detail
sellerId:
string
(no description)
buyerId:
string
(no description)
buyerName:
string
(no description)
email:
string
(no description)
fullName:
string
(no description)
fullAddress:
string
(no description)
logistixLocation:
string
(no description)
logistixLocationCode:
string
(no description)
postalCode:
string
(no description)
Example
Request Content-Types:
application/json
Query
mutation updateBuyerDetail($sellerId: String!, $buyerId: String!, $buyerName: String, $email: String, $fullName: String, $fullAddress: String, $logistixLocation: String, $logistixLocationCode: String, $postalCode: String){
updateBuyerDetail(sellerId: $sellerId, buyerId: $buyerId, buyerName: $buyerName, email: $email, fullName: $fullName, fullAddress: $fullAddress, logistixLocation: $logistixLocation, logistixLocationCode: $logistixLocationCode, postalCode: $postalCode){
id
name
channel
isRead
lastMessageId
isArchived
createdAt
updatedAt
unreadCount
}
}
Variables
{
"sellerId": "string",
"buyerId": "string",
"buyerName": "string",
"email": "string",
"fullName": "string",
"fullAddress": "string",
"logistixLocation": "string",
"logistixLocationCode": "string",
"postalCode": "string"
}
mutation updateBuyerDetail($sellerId: String!, $buyerId: String!, $buyerName: String, $email: String, $fullName: String, $fullAddress: String, $logistixLocation: String, $logistixLocationCode: String, $postalCode: String){
updateBuyerDetail(sellerId: $sellerId, buyerId: $buyerId, buyerName: $buyerName, email: $email, fullName: $fullName, fullAddress: $fullAddress, logistixLocation: $logistixLocation, logistixLocationCode: $logistixLocationCode, postalCode: $postalCode){
id
name
channel
isRead
lastMessageId
isArchived
createdAt
updatedAt
unreadCount
}
}
{
"sellerId": "string",
"buyerId": "string",
"buyerName": "string",
"email": "string",
"fullName": "string",
"fullAddress": "string",
"logistixLocation": "string",
"logistixLocationCode": "string",
"postalCode": "string"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"updateBuyerDetail": {
"id": "string",
"name": "string",
"channel": "string",
"isRead": "boolean",
"lastMessageId": "integer",
"isArchived": "boolean",
"createdAt": "string",
"updatedAt": "string",
"unreadCount": "integer"
}
}
}
Chat Exchange Transaction ID
Chat Exhange Transaction ID
Mutation for Chat Exchange Transaction ID
sellerId:
string
(no description)
buyerId:
string
(no description)
buyerName:
string
(no description)
email:
string
(no description)
fullName:
string
(no description)
fullAddress:
string
(no description)
logistixLocation:
string
(no description)
logistixLocationCode:
string
(no description)
postalCode:
string
(no description)
Example
Request Content-Types:
application/json
Query
mutation updateBuyerDetail($sellerId: String!, $buyerId: String!, $buyerName: String, $email: String, $fullName: String, $fullAddress: String, $logistixLocation: String, $logistixLocationCode: String, $postalCode: String){
updateBuyerDetail(sellerId: $sellerId, buyerId: $buyerId, buyerName: $buyerName, email: $email, fullName: $fullName, fullAddress: $fullAddress, logistixLocation: $logistixLocation, logistixLocationCode: $logistixLocationCode, postalCode: $postalCode){
id
name
channel
isRead
lastMessageId
isArchived
createdAt
updatedAt
unreadCount
}
}
Variables
{
"sellerId": "string",
"buyerId": "string",
"buyerName": "string",
"email": "string",
"fullName": "string",
"fullAddress": "string",
"logistixLocation": "string",
"logistixLocationCode": "string",
"postalCode": "string"
}
mutation updateBuyerDetail($sellerId: String!, $buyerId: String!, $buyerName: String, $email: String, $fullName: String, $fullAddress: String, $logistixLocation: String, $logistixLocationCode: String, $postalCode: String){
updateBuyerDetail(sellerId: $sellerId, buyerId: $buyerId, buyerName: $buyerName, email: $email, fullName: $fullName, fullAddress: $fullAddress, logistixLocation: $logistixLocation, logistixLocationCode: $logistixLocationCode, postalCode: $postalCode){
id
name
channel
isRead
lastMessageId
isArchived
createdAt
updatedAt
unreadCount
}
}
{
"sellerId": "string",
"buyerId": "string",
"buyerName": "string",
"email": "string",
"fullName": "string",
"fullAddress": "string",
"logistixLocation": "string",
"logistixLocationCode": "string",
"postalCode": "string"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"updateBuyerDetail": {
"id": "string",
"name": "string",
"channel": "string",
"isRead": "boolean",
"lastMessageId": "integer",
"isArchived": "boolean",
"createdAt": "string",
"updatedAt": "string",
"unreadCount": "integer"
}
}
}
Publish Cart ID
Publish Cart ID
Mutation for Publish Cart ID
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation publishCartID($input: PublishCartIDInput!){
publishCartID(input: $input){
sellerId
buyerId
cartId
}
}
Variables
{
"input": {
"sellerId": "string",
"buyerId": "string",
"cartId": "string"
}
}
mutation publishCartID($input: PublishCartIDInput!){
publishCartID(input: $input){
sellerId
buyerId
cartId
}
}
{
"input": {
"sellerId": "string",
"buyerId": "string",
"cartId": "string"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"publishCartID": {
"sellerId": "string",
"buyerId": "string",
"cartId": "string"
}
}
}
Manage Orders
This endpoint used to create and set order in your store
Create Order
Mutation to create order
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation createOrder($input: CreateOrderInput!){
createOrder(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
Variables
{
"input": {
"brandID": "string",
"specs": [
{
"memberID": "string",
"invoiceID": "string",
"channelID": "string",
"discount": {
"code": "string",
"value": "number"
},
"totalCost": {
"code": "string",
"value": "number"
},
"buyerNote": "string",
"billingAddress": {
"name": "string",
"email": "string",
"phone": "string",
"country": "string",
"province": "string",
"city": "string",
"subDistrict": "string",
"street": "string",
"districtCode": "string",
"postalCode": "string"
},
"deliveryAddress": {
"name": "string",
"email": "string",
"phone": "string",
"country": "string",
"province": "string",
"city": "string",
"subDistrict": "string",
"street": "string",
"districtCode": "string",
"postalCode": "string"
},
"lineItems": [
{
"title": "string",
"SKU": "string",
"quantity": "number",
"price": {
"code": "string",
"value": "number"
},
"imageURL": "string"
}
],
"shipping": {
"provider": "string",
"service": "string",
"cost": {
"code": "string"
}
}
}
]
}
}
mutation createOrder($input: CreateOrderInput!){
createOrder(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
{
"input": {
"brandID": "string",
"specs": [
{
"memberID": "string",
"invoiceID": "string",
"channelID": "string",
"discount": {
"code": "string",
"value": "number"
},
"totalCost": {
"code": "string",
"value": "number"
},
"buyerNote": "string",
"billingAddress": {
"name": "string",
"email": "string",
"phone": "string",
"country": "string",
"province": "string",
"city": "string",
"subDistrict": "string",
"street": "string",
"districtCode": "string",
"postalCode": "string"
},
"deliveryAddress": {
"name": "string",
"email": "string",
"phone": "string",
"country": "string",
"province": "string",
"city": "string",
"subDistrict": "string",
"street": "string",
"districtCode": "string",
"postalCode": "string"
},
"lineItems": [
{
"title": "string",
"SKU": "string",
"quantity": "number",
"price": {
"code": "string",
"value": "number"
},
"imageURL": "string"
}
],
"shipping": {
"provider": "string",
"service": "string",
"cost": {
"code": "string"
}
}
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createOrder": [
{
"ID": "string",
"brandID": "string",
"channelID": "string",
"invoiceID": "string",
"createdAt": "integer",
"updatedAt": "integer",
"paymentStatus": "string",
"memberID": "string",
"buyerNote": "string",
"paymentLinks": [
"string"
]
}
]
}
}
Upsert Order
Mutation to Upsert Order
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertOrder($input: UpsertOrderInput!){
upsertOrder(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
Variables
{
"input": {
"brandID": "string",
"specs": [
{
"ID": "string",
"spec": {
"memberID": "string",
"invoiceID": "string",
"channelID": "string",
"discount": {
"code": "string",
"value": "number"
},
"totalCost": {
"code": "string",
"value": "number"
},
"buyerNote": "string",
"billingAddress": {
"name": "string",
"email": "string",
"phone": "string",
"country": "string",
"province": "string",
"city": "string",
"subDistrict": "string",
"street": "string",
"districtCode": "string",
"postalCode": "string"
},
"deliveryAddress": {
"name": "string",
"email": "string",
"phone": "string",
"country": "string",
"province": "string",
"city": "string",
"subDistrict": "string",
"street": "string",
"districtCode": "string",
"postalCode": "string"
},
"lineItems": [
{
"title": "string",
"SKU": "string",
"quantity": "number",
"price": {
"code": "string",
"value": "number"
},
"imageURL": "string"
}
],
"shipping": {
"provider": "string",
"service": "string"
}
}
}
]
}
}
mutation upsertOrder($input: UpsertOrderInput!){
upsertOrder(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
{
"input": {
"brandID": "string",
"specs": [
{
"ID": "string",
"spec": {
"memberID": "string",
"invoiceID": "string",
"channelID": "string",
"discount": {
"code": "string",
"value": "number"
},
"totalCost": {
"code": "string",
"value": "number"
},
"buyerNote": "string",
"billingAddress": {
"name": "string",
"email": "string",
"phone": "string",
"country": "string",
"province": "string",
"city": "string",
"subDistrict": "string",
"street": "string",
"districtCode": "string",
"postalCode": "string"
},
"deliveryAddress": {
"name": "string",
"email": "string",
"phone": "string",
"country": "string",
"province": "string",
"city": "string",
"subDistrict": "string",
"street": "string",
"districtCode": "string",
"postalCode": "string"
},
"lineItems": [
{
"title": "string",
"SKU": "string",
"quantity": "number",
"price": {
"code": "string",
"value": "number"
},
"imageURL": "string"
}
],
"shipping": {
"provider": "string",
"service": "string"
}
}
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertOrder": [
{
"ID": "string",
"brandID": "string",
"channelID": "string",
"invoiceID": "string",
"createdAt": "integer",
"updatedAt": "integer",
"paymentStatus": "string",
"memberID": "string",
"buyerNote": "string",
"paymentLinks": [
"string"
]
}
]
}
}
Create Order Store
Base method to create Order Store
brandId:
string
(no description)
createOrderParam:
(no description)
buyerPhone:
string
(no description)
sellerPhone:
string
(no description)
channel:
string
(no description)
author:
string
(no description)
customOrderSummary:
string
(no description)
Example
Request Content-Types:
application/json
Query
mutation createOrderStore($brandId: String!, $createOrderParam: CreateOrderParam!, $buyerPhone: String!, $sellerPhone: String!, $channel: String!, $author: String, $customOrderSummary: String){
createOrderStore(brandId: $brandId, createOrderParam: $createOrderParam, buyerPhone: $buyerPhone, sellerPhone: $sellerPhone, channel: $channel, author: $author, customOrderSummary: $customOrderSummary){
status
message
}
}
Variables
{
"brandId": "string",
"createOrderParam": {
"billingInfo": {
"salutation": "string",
"fullName": "string",
"addressLine": "string",
"district": "string",
"city": "string",
"province": "string",
"country": "string",
"phoneNumber": "string",
"email": "string",
"postalCode": "string"
},
"shippingInfo": {
"method": "string",
"cost": "number"
},
"sameWithBillingInfo": "boolean",
"items": [
{
"productCode": "string",
"quantity": "number"
}
],
"payments": {
"coupon": "string",
"method": "string"
},
"buyersMessage": "string"
},
"buyerPhone": "string",
"sellerPhone": "string",
"channel": "string",
"author": "string",
"customOrderSummary": "string"
}
mutation createOrderStore($brandId: String!, $createOrderParam: CreateOrderParam!, $buyerPhone: String!, $sellerPhone: String!, $channel: String!, $author: String, $customOrderSummary: String){
createOrderStore(brandId: $brandId, createOrderParam: $createOrderParam, buyerPhone: $buyerPhone, sellerPhone: $sellerPhone, channel: $channel, author: $author, customOrderSummary: $customOrderSummary){
status
message
}
}
{
"brandId": "string",
"createOrderParam": {
"billingInfo": {
"salutation": "string",
"fullName": "string",
"addressLine": "string",
"district": "string",
"city": "string",
"province": "string",
"country": "string",
"phoneNumber": "string",
"email": "string",
"postalCode": "string"
},
"shippingInfo": {
"method": "string",
"cost": "number"
},
"sameWithBillingInfo": "boolean",
"items": [
{
"productCode": "string",
"quantity": "number"
}
],
"payments": {
"coupon": "string",
"method": "string"
},
"buyersMessage": "string"
},
"buyerPhone": "string",
"sellerPhone": "string",
"channel": "string",
"author": "string",
"customOrderSummary": "string"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createOrderStore": {
"status": "integer",
"message": "string"
}
}
}
Create Order OMS
Base method to create order OMS
brandID:
string
(no description)
orderSpecs:
(no description)
Example
Request Content-Types:
application/json
Query
mutation createOrderOMS($brandID: String!, $orderSpecs: [OrderSpecs!]){
createOrderOMS(brandID: $brandID, orderSpecs: $orderSpecs){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
Variables
{
"brandID": "string",
"orderSpecs": [
{
"memberID": "string",
"invoiceID": "string",
"channelID": "string",
"discount": {
"code": "string",
"value": "number"
},
"totalCost": {
"code": "string",
"value": "number"
},
"buyerNote": "string",
"billingAddress": {
"name": "string",
"email": "string",
"phone": "string",
"country": "string",
"province": "string",
"city": "string",
"subDistrict": "string",
"street": "string",
"districtCode": "string",
"postalCode": "string"
},
"deliveryAddress": {
"name": "string",
"email": "string",
"phone": "string",
"country": "string",
"province": "string",
"city": "string",
"subDistrict": "string",
"street": "string",
"districtCode": "string",
"postalCode": "string"
},
"lineItems": [
{
"title": "string",
"SKU": "string",
"quantity": "number",
"price": {
"code": "string",
"value": "number"
},
"imageURL": "string"
}
],
"shipping": {
"provider": "string",
"service": "string",
"cost": {
"code": "string",
"value": "number"
},
"AWBNumber": "string"
}
}
]
}
mutation createOrderOMS($brandID: String!, $orderSpecs: [OrderSpecs!]){
createOrderOMS(brandID: $brandID, orderSpecs: $orderSpecs){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
{
"brandID": "string",
"orderSpecs": [
{
"memberID": "string",
"invoiceID": "string",
"channelID": "string",
"discount": {
"code": "string",
"value": "number"
},
"totalCost": {
"code": "string",
"value": "number"
},
"buyerNote": "string",
"billingAddress": {
"name": "string",
"email": "string",
"phone": "string",
"country": "string",
"province": "string",
"city": "string",
"subDistrict": "string",
"street": "string",
"districtCode": "string",
"postalCode": "string"
},
"deliveryAddress": {
"name": "string",
"email": "string",
"phone": "string",
"country": "string",
"province": "string",
"city": "string",
"subDistrict": "string",
"street": "string",
"districtCode": "string",
"postalCode": "string"
},
"lineItems": [
{
"title": "string",
"SKU": "string",
"quantity": "number",
"price": {
"code": "string",
"value": "number"
},
"imageURL": "string"
}
],
"shipping": {
"provider": "string",
"service": "string",
"cost": {
"code": "string",
"value": "number"
},
"AWBNumber": "string"
}
}
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createOrderOMS": [
{
"ID": "string",
"brandID": "string",
"channelID": "string",
"invoiceID": "string",
"createdAt": "integer",
"updatedAt": "integer",
"paymentStatus": "string",
"memberID": "string",
"buyerNote": "string",
"paymentLinks": [
"string"
]
}
]
}
}
Update Order Status OMS
Base method to update order status OMS
updateOrderParams:
(no description)
Example
Request Content-Types:
application/json
Query
mutation updateOrderStatusOMS($updateOrderParams: [UpdateOrderStatusParam!]!){
updateOrderStatusOMS(updateOrderParams: $updateOrderParams){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
Variables
{
"updateOrderParams": [
{
"orderID": "string",
"status": "string",
"messages": "string",
"awb": "string"
}
]
}
mutation updateOrderStatusOMS($updateOrderParams: [UpdateOrderStatusParam!]!){
updateOrderStatusOMS(updateOrderParams: $updateOrderParams){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
{
"updateOrderParams": [
{
"orderID": "string",
"status": "string",
"messages": "string",
"awb": "string"
}
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"updateOrderStatusOMS": [
{
"ID": "string",
"brandID": "string",
"channelID": "string",
"invoiceID": "string",
"createdAt": "integer",
"updatedAt": "integer",
"paymentStatus": "string",
"memberID": "string",
"buyerNote": "string",
"paymentLinks": [
"string"
]
}
]
}
}
Set Order Attributes
Mutation to set Order Attributes
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setOrderAttributes($input: SetOrderAttributesInput!){
setOrderAttributes(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
Variables
{
"input": {
"orderID": "string",
"attributes": [
{
"key": "string",
"value": "string"
}
]
}
}
mutation setOrderAttributes($input: SetOrderAttributesInput!){
setOrderAttributes(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
{
"input": {
"orderID": "string",
"attributes": [
{
"key": "string",
"value": "string"
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setOrderAttributes": {
"ID": "string",
"brandID": "string",
"channelID": "string",
"invoiceID": "string",
"createdAt": "integer",
"updatedAt": "integer",
"paymentStatus": "string",
"memberID": "string",
"buyerNote": "string",
"paymentLinks": [
"string"
]
}
}
}
Set Order Billing
Mutation to set Order Billing
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setOrderBilling($input: SetOrderBillingInput!){
setOrderBilling(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
Variables
{
"input": {
"orderID": "string",
"billingAddress": {
"name": "string",
"email": "string",
"phone": "string",
"country": "string",
"province": "string",
"city": "string",
"subDistrict": "string",
"street": "string",
"districtCode": "string",
"postalCode": "string"
}
}
}
mutation setOrderBilling($input: SetOrderBillingInput!){
setOrderBilling(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
{
"input": {
"orderID": "string",
"billingAddress": {
"name": "string",
"email": "string",
"phone": "string",
"country": "string",
"province": "string",
"city": "string",
"subDistrict": "string",
"street": "string",
"districtCode": "string",
"postalCode": "string"
}
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setOrderBilling": {
"ID": "string",
"brandID": "string",
"channelID": "string",
"invoiceID": "string",
"createdAt": "integer",
"updatedAt": "integer",
"paymentStatus": "string",
"memberID": "string",
"buyerNote": "string",
"paymentLinks": [
"string"
]
}
}
}
Set Order Status As Accepted
Mutation to Set Order Status As Accepted
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setOrderStatusAsAccepted($input: StatusInput){
setOrderStatusAsAccepted(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
Variables
{
"input": {
"notes": "string",
"orderIDs": [
"string"
]
}
}
mutation setOrderStatusAsAccepted($input: StatusInput){
setOrderStatusAsAccepted(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
{
"input": {
"notes": "string",
"orderIDs": [
"string"
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setOrderStatusAsAccepted": [
{
"ID": "string",
"brandID": "string",
"channelID": "string",
"invoiceID": "string",
"createdAt": "integer",
"updatedAt": "integer",
"paymentStatus": "string",
"memberID": "string",
"buyerNote": "string",
"paymentLinks": [
"string"
]
}
]
}
}
Set Order Status As Cancelled
Mutation to Set Order Status As Cancelled
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setOrderStatusAsCanceled($input: GranularStatusInput){
setOrderStatusAsCanceled(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
Variables
{
"input": {
"specs": [
{
"notes": "string",
"orderID": "string"
}
]
}
}
mutation setOrderStatusAsCanceled($input: GranularStatusInput){
setOrderStatusAsCanceled(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
{
"input": {
"specs": [
{
"notes": "string",
"orderID": "string"
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setOrderStatusAsCanceled": [
{
"ID": "string",
"brandID": "string",
"channelID": "string",
"invoiceID": "string",
"createdAt": "integer",
"updatedAt": "integer",
"paymentStatus": "string",
"memberID": "string",
"buyerNote": "string",
"paymentLinks": [
"string"
]
}
]
}
}
Set Order Status As Completed
Mutation to Set Order Status As Completed
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setOrderStatusAsCompleted($input: StatusInput){
setOrderStatusAsCompleted(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
Variables
{
"input": {
"notes": "string",
"orderIDs": [
"string"
]
}
}
mutation setOrderStatusAsCompleted($input: StatusInput){
setOrderStatusAsCompleted(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
{
"input": {
"notes": "string",
"orderIDs": [
"string"
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setOrderStatusAsCompleted": [
{
"ID": "string",
"brandID": "string",
"channelID": "string",
"invoiceID": "string",
"createdAt": "integer",
"updatedAt": "integer",
"paymentStatus": "string",
"memberID": "string",
"buyerNote": "string",
"paymentLinks": [
"string"
]
}
]
}
}
Set Order Status As Ready To Ship
Mutation to Set Order Status As Ready To Ship
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setOrderStatusAsReadyToShip($input: AWBStatusInput){
setOrderStatusAsReadyToShip(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
Variables
{
"input": {
"specs": [
{
"AWBNumber": "string",
"orderID": "string",
"isAutoAwb": "boolean"
}
]
}
}
mutation setOrderStatusAsReadyToShip($input: AWBStatusInput){
setOrderStatusAsReadyToShip(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
{
"input": {
"specs": [
{
"AWBNumber": "string",
"orderID": "string",
"isAutoAwb": "boolean"
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setOrderStatusAsReadyToShip": [
{
"ID": "string",
"brandID": "string",
"channelID": "string",
"invoiceID": "string",
"createdAt": "integer",
"updatedAt": "integer",
"paymentStatus": "string",
"memberID": "string",
"buyerNote": "string",
"paymentLinks": [
"string"
]
}
]
}
}
Set Order Status As Returned
Mutation to Set Order Status As Returned
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setOrderStatusAsReturned($input: StatusInput){
setOrderStatusAsReturned(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
Variables
{
"input": {
"notes": "string",
"orderIDs": [
"string"
]
}
}
mutation setOrderStatusAsReturned($input: StatusInput){
setOrderStatusAsReturned(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
{
"input": {
"notes": "string",
"orderIDs": [
"string"
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setOrderStatusAsReturned": [
{
"ID": "string",
"brandID": "string",
"channelID": "string",
"invoiceID": "string",
"createdAt": "integer",
"updatedAt": "integer",
"paymentStatus": "string",
"memberID": "string",
"buyerNote": "string",
"paymentLinks": [
"string"
]
}
]
}
}
Set Order Status As Shipped
Mutation to Set Order Status As Shipped
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setOrderStatusAsShipped($input: StatusInput){
setOrderStatusAsShipped(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
Variables
{
"input": {
"notes": "string",
"orderIDs": [
"string"
]
}
}
mutation setOrderStatusAsShipped($input: StatusInput){
setOrderStatusAsShipped(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
{
"input": {
"notes": "string",
"orderIDs": [
"string"
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setOrderStatusAsShipped": [
{
"ID": "string",
"brandID": "string",
"channelID": "string",
"invoiceID": "string",
"createdAt": "integer",
"updatedAt": "integer",
"paymentStatus": "string",
"memberID": "string",
"buyerNote": "string",
"paymentLinks": [
"string"
]
}
]
}
}
Product Operations
This endpoint used to manage your product store
Create Product
Mutation to create product
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation createProduct($input: CreateProductInput!){
createProduct(input: $input){
ID
brandID
relatedProductIDs
slug
published
imageURLs
condition
tagKeys
collectionIDs
schedulePublishAt
scheduleOpenOrderAt
scheduleCloseOrderAt
syncStatus
}
}
Variables
{
"input": {
"brandID": "object",
"specs": [
{
"details": [
{
"name": "string",
"description": "string",
"language": "string"
}
],
"volume": {
"length": "number",
"height": "number",
"width": "number",
"unit": "string"
},
"weight": {
"value": "number",
"unit": "string"
},
"imageURLs": [
"string"
],
"published": "boolean",
"variants": [
{
"SKU": "object",
"options": [
{
"key": "object",
"value": "string"
}
],
"basePrices": [
{
"code": "string",
"value": "number"
}
],
"channelIDs": [
"string"
],
"attributes": [
{
"sortIndex": "number",
"translations": [
{
"key": "string",
"value": "string",
"language": "string"
}
]
}
],
"channelAttributes": [
{
"channelID": "string",
"key": "object",
"value": "string"
}
],
"imageURLs": [
"string"
],
"stock": "number",
"ignoreStock": "boolean"
}
],
"slug": "string",
"SEOs": [
{
"title": "string",
"description": "string",
"keywords": [
null
]
}
]
}
]
}
}
mutation createProduct($input: CreateProductInput!){
createProduct(input: $input){
ID
brandID
relatedProductIDs
slug
published
imageURLs
condition
tagKeys
collectionIDs
schedulePublishAt
scheduleOpenOrderAt
scheduleCloseOrderAt
syncStatus
}
}
{
"input": {
"brandID": "object",
"specs": [
{
"details": [
{
"name": "string",
"description": "string",
"language": "string"
}
],
"volume": {
"length": "number",
"height": "number",
"width": "number",
"unit": "string"
},
"weight": {
"value": "number",
"unit": "string"
},
"imageURLs": [
"string"
],
"published": "boolean",
"variants": [
{
"SKU": "object",
"options": [
{
"key": "object",
"value": "string"
}
],
"basePrices": [
{
"code": "string",
"value": "number"
}
],
"channelIDs": [
"string"
],
"attributes": [
{
"sortIndex": "number",
"translations": [
{
"key": "string",
"value": "string",
"language": "string"
}
]
}
],
"channelAttributes": [
{
"channelID": "string",
"key": "object",
"value": "string"
}
],
"imageURLs": [
"string"
],
"stock": "number",
"ignoreStock": "boolean"
}
],
"slug": "string",
"SEOs": [
{
"title": "string",
"description": "string",
"keywords": [
null
]
}
]
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createProduct": [
{
"ID": "string",
"brandID": "string",
"relatedProductIDs": [
"string"
],
"slug": "string",
"published": "boolean",
"imageURLs": [
"string"
],
"condition": "string",
"tagKeys": [
"string"
],
"collectionIDs": [
"string"
],
"schedulePublishAt": "integer",
"scheduleOpenOrderAt": "integer",
"scheduleCloseOrderAt": "integer"
}
]
}
}
Upsert Product
Mutation to Upsert Product
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertProduct($input: UpsertProductInput!){
upsertProduct(input: $input){
ID
brandID
relatedProductIDs
slug
published
imageURLs
condition
tagKeys
collectionIDs
schedulePublishAt
scheduleOpenOrderAt
scheduleCloseOrderAt
syncStatus
}
}
Variables
{
"input": {
"brandID": "object",
"specs": [
{
"details": [
{
"name": "string",
"description": "string",
"language": "string"
}
],
"volume": {
"length": "number",
"height": "number",
"width": "number",
"unit": "string"
},
"weight": {
"value": "number",
"unit": "string"
},
"imageURLs": [
"string"
],
"published": "boolean",
"variants": [
{
"SKU": "object",
"options": [
{
"key": "object",
"value": "string"
}
],
"basePrices": [
{
"code": "string",
"value": "number"
}
],
"channelIDs": [
"string"
],
"attributes": [
{
"sortIndex": "number",
"translations": [
{
"key": "string",
"value": "string",
"language": "string"
}
]
}
],
"channelAttributes": [
{
"channelID": "string",
"key": "object",
"value": "string"
}
],
"imageURLs": [
"string"
],
"stock": "number",
"warehouseID": "string",
"currentStock": "number",
"ignoreCurrentStock": "boolean",
"ignoreStock": "boolean"
}
],
"productID": "object",
"slug": "string"
}
]
}
}
mutation upsertProduct($input: UpsertProductInput!){
upsertProduct(input: $input){
ID
brandID
relatedProductIDs
slug
published
imageURLs
condition
tagKeys
collectionIDs
schedulePublishAt
scheduleOpenOrderAt
scheduleCloseOrderAt
syncStatus
}
}
{
"input": {
"brandID": "object",
"specs": [
{
"details": [
{
"name": "string",
"description": "string",
"language": "string"
}
],
"volume": {
"length": "number",
"height": "number",
"width": "number",
"unit": "string"
},
"weight": {
"value": "number",
"unit": "string"
},
"imageURLs": [
"string"
],
"published": "boolean",
"variants": [
{
"SKU": "object",
"options": [
{
"key": "object",
"value": "string"
}
],
"basePrices": [
{
"code": "string",
"value": "number"
}
],
"channelIDs": [
"string"
],
"attributes": [
{
"sortIndex": "number",
"translations": [
{
"key": "string",
"value": "string",
"language": "string"
}
]
}
],
"channelAttributes": [
{
"channelID": "string",
"key": "object",
"value": "string"
}
],
"imageURLs": [
"string"
],
"stock": "number",
"warehouseID": "string",
"currentStock": "number",
"ignoreCurrentStock": "boolean",
"ignoreStock": "boolean"
}
],
"productID": "object",
"slug": "string"
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertProduct": [
{
"ID": "string",
"brandID": "string",
"relatedProductIDs": [
"string"
],
"slug": "string",
"published": "boolean",
"imageURLs": [
"string"
],
"condition": "string",
"tagKeys": [
"string"
],
"collectionIDs": [
"string"
],
"schedulePublishAt": "integer",
"scheduleOpenOrderAt": "integer",
"scheduleCloseOrderAt": "integer"
}
]
}
}
Delete Product
Mutation to Delete Product
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation deleteProducts($input: DeleteProductsInput!){
deleteProducts(input: $input){
ID
brandID
relatedProductIDs
slug
published
imageURLs
condition
tagKeys
collectionIDs
schedulePublishAt
scheduleOpenOrderAt
scheduleCloseOrderAt
syncStatus
}
}
Variables
{
"input": {
"IDs": [
"object"
]
}
}
mutation deleteProducts($input: DeleteProductsInput!){
deleteProducts(input: $input){
ID
brandID
relatedProductIDs
slug
published
imageURLs
condition
tagKeys
collectionIDs
schedulePublishAt
scheduleOpenOrderAt
scheduleCloseOrderAt
syncStatus
}
}
{
"input": {
"IDs": [
"object"
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteProducts": [
{
"ID": "string",
"brandID": "string",
"relatedProductIDs": [
"string"
],
"slug": "string",
"published": "boolean",
"imageURLs": [
"string"
],
"condition": "string",
"tagKeys": [
"string"
],
"collectionIDs": [
"string"
],
"schedulePublishAt": "integer",
"scheduleOpenOrderAt": "integer",
"scheduleCloseOrderAt": "integer"
}
]
}
}
Publish Products
Mutation to Publish Products
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation publishProducts($input: SetStatusProductsInput!){
publishProducts(input: $input){
ID
brandID
relatedProductIDs
slug
published
imageURLs
condition
tagKeys
collectionIDs
schedulePublishAt
scheduleOpenOrderAt
scheduleCloseOrderAt
syncStatus
}
}
Variables
{
"input": {
"IDs": [
"object"
]
}
}
mutation publishProducts($input: SetStatusProductsInput!){
publishProducts(input: $input){
ID
brandID
relatedProductIDs
slug
published
imageURLs
condition
tagKeys
collectionIDs
schedulePublishAt
scheduleOpenOrderAt
scheduleCloseOrderAt
syncStatus
}
}
{
"input": {
"IDs": [
"object"
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"publishProducts": [
{
"ID": "string",
"brandID": "string",
"relatedProductIDs": [
"string"
],
"slug": "string",
"published": "boolean",
"imageURLs": [
"string"
],
"condition": "string",
"tagKeys": [
"string"
],
"collectionIDs": [
"string"
],
"schedulePublishAt": "integer",
"scheduleOpenOrderAt": "integer",
"scheduleCloseOrderAt": "integer"
}
]
}
}
Unpublish Products
Mutation to Unpublish Products
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation unpublishProducts($input: SetStatusProductsInput!){
unpublishProducts(input: $input){
ID
brandID
relatedProductIDs
slug
published
imageURLs
condition
tagKeys
collectionIDs
schedulePublishAt
scheduleOpenOrderAt
scheduleCloseOrderAt
syncStatus
}
}
Variables
{
"input": {
"IDs": [
"object"
]
}
}
mutation unpublishProducts($input: SetStatusProductsInput!){
unpublishProducts(input: $input){
ID
brandID
relatedProductIDs
slug
published
imageURLs
condition
tagKeys
collectionIDs
schedulePublishAt
scheduleOpenOrderAt
scheduleCloseOrderAt
syncStatus
}
}
{
"input": {
"IDs": [
"object"
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"unpublishProducts": [
{
"ID": "string",
"brandID": "string",
"relatedProductIDs": [
"string"
],
"slug": "string",
"published": "boolean",
"imageURLs": [
"string"
],
"condition": "string",
"tagKeys": [
"string"
],
"collectionIDs": [
"string"
],
"schedulePublishAt": "integer",
"scheduleOpenOrderAt": "integer",
"scheduleCloseOrderAt": "integer"
}
]
}
}
Update Product Stock And Price
Mutation to update product stock and price
(no description)
Example
Request Content-Types:
application/json
Query
mutation updateProductStockAndPrice($input: UpdateProductStockAndPriceInput!){
updateProductStockAndPrice(input: $input){
productID
SKU
updatePriceError
updateStockError
warehouseID
}
}
Variables
{
"input": {
"brandID": "object",
"specs": [
{
"productID": "string",
"basePrices": [
{
"code": "string",
"value": "number"
}
],
"currentStock": "number",
"stock": "number",
"ignoreCurrentStock": "boolean",
"ignoreStock": "boolean",
"warehouseID": "string",
"SKU": "string"
}
]
}
}
mutation updateProductStockAndPrice($input: UpdateProductStockAndPriceInput!){
updateProductStockAndPrice(input: $input){
productID
SKU
updatePriceError
updateStockError
warehouseID
}
}
{
"input": {
"brandID": "object",
"specs": [
{
"productID": "string",
"basePrices": [
{
"code": "string",
"value": "number"
}
],
"currentStock": "number",
"stock": "number",
"ignoreCurrentStock": "boolean",
"ignoreStock": "boolean",
"warehouseID": "string",
"SKU": "string"
}
]
}
}
200 OK
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"updateProductStockAndPrice": [
{
"productID": "string",
"SKU": "string",
"updatePriceError": "string",
"updateStockError": "string",
"warehouseID": "string"
}
]
}
}
Export Products
Mutation to Export Products
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation exportProducts($input: ExportProductsInput!){
exportProducts(input: $input)
}
Variables
{
"input": {
"brandID": "object",
"spec": {
"columnNames": [
"string"
],
"IDs": [
"object"
],
"sendToEmail": "string"
}
}
}
mutation exportProducts($input: ExportProductsInput!){
exportProducts(input: $input)
}
{
"input": {
"brandID": "object",
"spec": {
"columnNames": [
"string"
],
"IDs": [
"object"
],
"sendToEmail": "string"
}
}
}
200 OK
Successful operation
type
string
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"exportProducts": "string"
}
}
Collection operation
This endpoint used to delete collection
Delete collection
Mutation to Delete collection
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation deleteCollection($input: CollectionDeleteInput!){
deleteCollection(input: $input){
ID
slug
imageURLs
published
channelIDs
parentIDs
}
}
Variables
{
"input": {
"IDs": [
"object"
]
}
}
mutation deleteCollection($input: CollectionDeleteInput!){
deleteCollection(input: $input){
ID
slug
imageURLs
published
channelIDs
parentIDs
}
}
{
"input": {
"IDs": [
"object"
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteCollection": [
{
"ID": "string",
"slug": "string",
"imageURLs": [
"string"
],
"published": "boolean",
"channelIDs": [
"string"
],
"parentIDs": [
"string"
]
}
]
}
}
Publish collections
Mutation to Publish collection
IDs:
string[]
(no description)
Example
Request Content-Types:
application/json
Query
mutation publishCollections($IDs: [ID!]!){
publishCollections(IDs: $IDs){
ID
slug
imageURLs
published
channelIDs
parentIDs
}
}
Variables
{
"IDs": [
"string"
]
}
mutation publishCollections($IDs: [ID!]!){
publishCollections(IDs: $IDs){
ID
slug
imageURLs
published
channelIDs
parentIDs
}
}
{
"IDs": [
"string"
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"publishCollections": [
{
"ID": "string",
"slug": "string",
"imageURLs": [
"string"
],
"published": "boolean",
"channelIDs": [
"string"
],
"parentIDs": [
"string"
]
}
]
}
}
Unpublish collections
Mutation to Unpublish collection
IDs:
string[]
(no description)
Example
Request Content-Types:
application/json
Query
mutation unpublishCollections($IDs: [ID!]!){
unpublishCollections(IDs: $IDs){
ID
slug
imageURLs
published
channelIDs
parentIDs
}
}
Variables
{
"IDs": [
"string"
]
}
mutation unpublishCollections($IDs: [ID!]!){
unpublishCollections(IDs: $IDs){
ID
slug
imageURLs
published
channelIDs
parentIDs
}
}
{
"IDs": [
"string"
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"unpublishCollections": [
{
"ID": "string",
"slug": "string",
"imageURLs": [
"string"
],
"published": "boolean",
"channelIDs": [
"string"
],
"parentIDs": [
"string"
]
}
]
}
}
Upsert Collection
Mutation to Upsert collection
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertCollection($input: CollectionUpsertInput!){
upsertCollection(input: $input){
ID
slug
imageURLs
published
channelIDs
parentIDs
}
}
Variables
{
"input": {
"brandID": "object",
"ID": "object",
"slug": "string",
"details": [
{
"name": "string",
"description": "string",
"language": "string"
}
],
"imageURLs": [
"string"
],
"published": "boolean",
"channelIDs": [
"object"
],
"SEOs": [
{
"title": "string",
"description": "string",
"keywords": [
"string"
],
"language": "string"
}
],
"attributes": [
{
"key": "string",
"value": "string"
}
],
"parentIDs": [
"object"
]
}
}
mutation upsertCollection($input: CollectionUpsertInput!){
upsertCollection(input: $input){
ID
slug
imageURLs
published
channelIDs
parentIDs
}
}
{
"input": {
"brandID": "object",
"ID": "object",
"slug": "string",
"details": [
{
"name": "string",
"description": "string",
"language": "string"
}
],
"imageURLs": [
"string"
],
"published": "boolean",
"channelIDs": [
"object"
],
"SEOs": [
{
"title": "string",
"description": "string",
"keywords": [
"string"
],
"language": "string"
}
],
"attributes": [
{
"key": "string",
"value": "string"
}
],
"parentIDs": [
"object"
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertCollection": [
{
"ID": "string",
"slug": "string",
"imageURLs": [
"string"
],
"published": "boolean",
"channelIDs": [
"string"
],
"parentIDs": [
"string"
]
}
]
}
}
Set Variant Base Price
This endpoint used to delete collection
Set Variant Base Price
Mutation to set Variant Base Price
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setVariantBasePrice($input: SetVariantBasePriceInput!){
setVariantBasePrice(input: $input){
ID
brandID
relatedProductIDs
slug
published
imageURLs
condition
tagKeys
collectionIDs
schedulePublishAt
scheduleOpenOrderAt
scheduleCloseOrderAt
syncStatus
}
}
Variables
{
"input": {
"productID": "object",
"specs": [
{
"SKU": "object",
"basePrices": [
{
"code": "string",
"value": "number"
}
]
}
]
}
}
mutation setVariantBasePrice($input: SetVariantBasePriceInput!){
setVariantBasePrice(input: $input){
ID
brandID
relatedProductIDs
slug
published
imageURLs
condition
tagKeys
collectionIDs
schedulePublishAt
scheduleOpenOrderAt
scheduleCloseOrderAt
syncStatus
}
}
{
"input": {
"productID": "object",
"specs": [
{
"SKU": "object",
"basePrices": [
{
"code": "string",
"value": "number"
}
]
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setVariantBasePrice": {
"ID": "string",
"brandID": "string",
"relatedProductIDs": [
"string"
],
"slug": "string",
"published": "boolean",
"imageURLs": [
"string"
],
"condition": "string",
"tagKeys": [
"string"
],
"collectionIDs": [
"string"
],
"schedulePublishAt": "integer",
"scheduleOpenOrderAt": "integer",
"scheduleCloseOrderAt": "integer"
}
}
}
Password Operations
This endpoint used to manage your password
Change Password
Mutation to change password
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation changePassword($input: ChangePasswordInput){
changePassword(input: $input){
accountID
ID
email
firstName
lastName
gender
phone
dateOfBirth
createdAt
updatedAt
level
haveAccessTo(specs: $specs)
}
}
Variables
{
"input": {
"data": {
"accountID": "string",
"oldPassword": "string",
"newPassword": "string"
},
"isAdmin": "boolean"
}
}
mutation changePassword($input: ChangePasswordInput){
changePassword(input: $input){
accountID
ID
email
firstName
lastName
gender
phone
dateOfBirth
createdAt
updatedAt
level
haveAccessTo(specs: $specs)
}
}
{
"input": {
"data": {
"accountID": "string",
"oldPassword": "string",
"newPassword": "string"
},
"isAdmin": "boolean"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"changePassword": {
"accountID": "string",
"ID": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"phone": "string",
"dateOfBirth": "integer",
"createdAt": "integer",
"updatedAt": "integer",
"level": "string",
"haveAccessTo": "boolean"
}
}
}
Forgot Password
Mutation to password password
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation forgotPassword($input: ForgotPasswordInput){
forgotPassword(input: $input)
}
Variables
{
"input": {
"brandID": "string",
"email": "string"
}
}
mutation forgotPassword($input: ForgotPasswordInput){
forgotPassword(input: $input)
}
{
"input": {
"brandID": "string",
"email": "string"
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"forgotPassword": "boolean"
}
}
reset Password
Mutation to reset password
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation resetPassword($input: ResetPasswordInput){
resetPassword(input: $input){
accountID
ID
email
firstName
lastName
gender
phone
dateOfBirth
createdAt
updatedAt
level
haveAccessTo(specs: $specs)
}
}
Variables
{
"input": {
"token": "string",
"newPassword": "string",
"isAdmin": "boolean"
}
}
mutation resetPassword($input: ResetPasswordInput){
resetPassword(input: $input){
accountID
ID
email
firstName
lastName
gender
phone
dateOfBirth
createdAt
updatedAt
level
haveAccessTo(specs: $specs)
}
}
{
"input": {
"token": "string",
"newPassword": "string",
"isAdmin": "boolean"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"resetPassword": {
"accountID": "string",
"ID": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"phone": "string",
"dateOfBirth": "integer",
"createdAt": "integer",
"updatedAt": "integer",
"level": "string",
"haveAccessTo": "boolean"
}
}
}
Manage Member
This endpoint uset to manage your member account
Upsert Member
Mutation to upsert member
input:
(no description)
isAdmin:
boolean
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertMember($input: UpsertMemberInput, $isAdmin: Boolean!){
upsertMember(input: $input, isAdmin: $isAdmin){
accountID
ID
email
firstName
lastName
gender
phone
dateOfBirth
createdAt
updatedAt
level
haveAccessTo(specs: $specs)
}
}
Variables
{
"input": {
"accountID": "string",
"spec": {
"brandID": "string",
"basicInfo": {
"email": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"phone": "string",
"dateOfBirth": "number"
},
"addresses": [
{
"addressLabel": "string",
"contactName": "string",
"districtCode": "string",
"street": "string",
"latitude": "string",
"longitude": "string",
"postalCode": "string",
"isPrimary": "boolean",
"salesChannel": "string"
}
]
}
},
"isAdmin": "boolean"
}
mutation upsertMember($input: UpsertMemberInput, $isAdmin: Boolean!){
upsertMember(input: $input, isAdmin: $isAdmin){
accountID
ID
email
firstName
lastName
gender
phone
dateOfBirth
createdAt
updatedAt
level
haveAccessTo(specs: $specs)
}
}
{
"input": {
"accountID": "string",
"spec": {
"brandID": "string",
"basicInfo": {
"email": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"phone": "string",
"dateOfBirth": "number"
},
"addresses": [
{
"addressLabel": "string",
"contactName": "string",
"districtCode": "string",
"street": "string",
"latitude": "string",
"longitude": "string",
"postalCode": "string",
"isPrimary": "boolean",
"salesChannel": "string"
}
]
}
},
"isAdmin": "boolean"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertMember": {
"accountID": "string",
"ID": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"phone": "string",
"dateOfBirth": "integer",
"createdAt": "integer",
"updatedAt": "integer",
"level": "string",
"haveAccessTo": "boolean"
}
}
}
Upsert Member Address
Mutation to upsert member address
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertMemberAddress($input: UpsertMemberAddressInput!){
upsertMemberAddress(input: $input){
accountID
ID
email
firstName
lastName
gender
phone
dateOfBirth
createdAt
updatedAt
level
haveAccessTo(specs: $specs)
}
}
Variables
{
"input": {
"accountID": "string",
"brandID": "string",
"address": {
"addressLabel": "string",
"contactName": "string",
"districtCode": "string",
"street": "string",
"latitude": "string",
"longitude": "string",
"postalCode": "string",
"isPrimary": "boolean",
"salesChannel": "string"
}
}
}
mutation upsertMemberAddress($input: UpsertMemberAddressInput!){
upsertMemberAddress(input: $input){
accountID
ID
email
firstName
lastName
gender
phone
dateOfBirth
createdAt
updatedAt
level
haveAccessTo(specs: $specs)
}
}
{
"input": {
"accountID": "string",
"brandID": "string",
"address": {
"addressLabel": "string",
"contactName": "string",
"districtCode": "string",
"street": "string",
"latitude": "string",
"longitude": "string",
"postalCode": "string",
"isPrimary": "boolean",
"salesChannel": "string"
}
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertMemberAddress": {
"accountID": "string",
"ID": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"phone": "string",
"dateOfBirth": "integer",
"createdAt": "integer",
"updatedAt": "integer",
"level": "string",
"haveAccessTo": "boolean"
}
}
}
Register Member
Mutation to register new member
brandID:
string
(no description)
userProfile:
(no description)
password:
string
(no description)
isAdmin:
boolean
(no description)
Example
Request Content-Types:
application/json
Query
mutation registerMember($brandID: String, $userProfile: UserProfile!, $password: String!, $isAdmin: Boolean!){
registerMember(brandID: $brandID, userProfile: $userProfile, password: $password, isAdmin: $isAdmin){
accountID
ID
email
firstName
lastName
gender
phone
dateOfBirth
createdAt
updatedAt
level
haveAccessTo(specs: $specs)
}
}
Variables
{
"brandID": "string",
"userProfile": {
"basicInfo": {
"email": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"phone": "string",
"dateOfBirth": "number"
},
"addresses": [
{
"addressLabel": "string",
"contactName": "string",
"districtCode": "string",
"street": "string",
"latitude": "string",
"longitude": "string",
"postalCode": "string",
"isPrimary": "boolean",
"salesChannel": "string"
}
]
},
"password": "string",
"isAdmin": "boolean"
}
mutation registerMember($brandID: String, $userProfile: UserProfile!, $password: String!, $isAdmin: Boolean!){
registerMember(brandID: $brandID, userProfile: $userProfile, password: $password, isAdmin: $isAdmin){
accountID
ID
email
firstName
lastName
gender
phone
dateOfBirth
createdAt
updatedAt
level
haveAccessTo(specs: $specs)
}
}
{
"brandID": "string",
"userProfile": {
"basicInfo": {
"email": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"phone": "string",
"dateOfBirth": "number"
},
"addresses": [
{
"addressLabel": "string",
"contactName": "string",
"districtCode": "string",
"street": "string",
"latitude": "string",
"longitude": "string",
"postalCode": "string",
"isPrimary": "boolean",
"salesChannel": "string"
}
]
},
"password": "string",
"isAdmin": "boolean"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"registerMember": [
{
"accountID": "string",
"ID": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"phone": "string",
"dateOfBirth": "integer",
"createdAt": "integer",
"updatedAt": "integer",
"level": "string",
"haveAccessTo": "boolean"
}
]
}
}
Manage Account
This endpoint used to manage Account
Activate Account
Mutation to activate account
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation activateAccount($input: activateAccountInput!){
activateAccount(input: $input)
}
Variables
{
"input": {
"IDs": [
"object"
]
}
}
mutation activateAccount($input: activateAccountInput!){
activateAccount(input: $input)
}
{
"input": {
"IDs": [
"object"
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"activateAccount": "boolean"
}
}
Deactivate Account
Mutation to deactivate an account
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation deactivateAccount($input: deactivateAccountInput!){
deactivateAccount(input: $input)
}
Variables
{
"input": {
"IDs": [
"object"
]
}
}
mutation deactivateAccount($input: deactivateAccountInput!){
deactivateAccount(input: $input)
}
{
"input": {
"IDs": [
"object"
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deactivateAccount": "boolean"
}
}
Manage Admin
This endpoint to used manage admin on your store
Upsert Admin
Mutation to upsert an admin for specific tenant
input:
(no description)
isAdmin:
boolean
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertAdmin($input: UpsertAdminInput, $isAdmin: Boolean!){
upsertAdmin(input: $input, isAdmin: $isAdmin){
accountID
ID
email
firstName
lastName
gender
phone
dateOfBirth
createdAt
updatedAt
}
}
Variables
{
"input": {
"accountID": "string",
"spec": {
"tenantID": "string",
"basicInfo": {
"email": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"phone": "string",
"dateOfBirth": "number"
},
"addresses": [
{
"addressLabel": "string",
"contactName": "string",
"districtCode": "string",
"street": "string",
"latitude": "string",
"longitude": "string",
"postalCode": "string",
"isPrimary": "boolean"
}
]
}
},
"isAdmin": "boolean"
}
mutation upsertAdmin($input: UpsertAdminInput, $isAdmin: Boolean!){
upsertAdmin(input: $input, isAdmin: $isAdmin){
accountID
ID
email
firstName
lastName
gender
phone
dateOfBirth
createdAt
updatedAt
}
}
{
"input": {
"accountID": "string",
"spec": {
"tenantID": "string",
"basicInfo": {
"email": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"phone": "string",
"dateOfBirth": "number"
},
"addresses": [
{
"addressLabel": "string",
"contactName": "string",
"districtCode": "string",
"street": "string",
"latitude": "string",
"longitude": "string",
"postalCode": "string",
"isPrimary": "boolean"
}
]
}
},
"isAdmin": "boolean"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertAdmin": {
"accountID": "string",
"ID": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"phone": "string",
"dateOfBirth": "integer",
"createdAt": "integer",
"updatedAt": "integer"
}
}
}
Add Admin
Mutation to creates account, admin profile and send email to reset password link for each admin
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation addAdmin($input: AddAdminInput!){
addAdmin(input: $input)
}
Variables
{
"input": {
"spec": [
{
"info": {
"email": "string",
"phone": "string",
"name": "string",
"tenantID": "string",
"brandIDs": [
"string"
],
"allBrand": "boolean"
},
"permission": {
"actions": [
"string"
],
"allAction": "boolean"
}
}
]
}
}
mutation addAdmin($input: AddAdminInput!){
addAdmin(input: $input)
}
{
"input": {
"spec": [
{
"info": {
"email": "string",
"phone": "string",
"name": "string",
"tenantID": "string",
"brandIDs": [
"string"
],
"allBrand": "boolean"
},
"permission": {
"actions": [
"string"
],
"allAction": "boolean"
}
}
]
}
}
200 OK
Successful operation
type
string[]
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"addAdmin": [
"string"
]
}
}
Update Admin
Mutation to update admin
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation updateAdmin($input: UpdateAdminInput!){
updateAdmin(input: $input)
}
Variables
{
"input": {
"spec": [
{
"accountID": "string",
"adminSpec": {
"info": {
"email": "string",
"phone": "string",
"name": "string",
"tenantID": "string",
"brandIDs": [
"string"
],
"allBrand": "boolean"
},
"permission": {
"actions": [
"string"
],
"allAction": "boolean"
}
}
}
]
}
}
mutation updateAdmin($input: UpdateAdminInput!){
updateAdmin(input: $input)
}
{
"input": {
"spec": [
{
"accountID": "string",
"adminSpec": {
"info": {
"email": "string",
"phone": "string",
"name": "string",
"tenantID": "string",
"brandIDs": [
"string"
],
"allBrand": "boolean"
},
"permission": {
"actions": [
"string"
],
"allAction": "boolean"
}
}
}
]
}
}
200 OK
Successful operation
type
string[]
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"updateAdmin": [
"string"
]
}
}
Remove Admins
Mutation to remove admin
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation removeAdmins($input: removeAdminsInput!){
removeAdmins(input: $input)
}
Variables
{
"input": {
"accountIDs": [
"string"
]
}
}
mutation removeAdmins($input: removeAdminsInput!){
removeAdmins(input: $input)
}
{
"input": {
"accountIDs": [
"string"
]
}
}
200 OK
Successful operation
type
string[]
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"removeAdmins": [
"string"
]
}
}
Set Admins Actions
Mutation to set admin actions
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setAdminActions($input: SetAdminActions!){
setAdminActions(input: $input)
}
Variables
{
"input": {
"specs": [
{
"accountID": "string",
"actions": [
"string"
],
"brandIDs": [
"string"
],
"allAction": "boolean"
}
]
}
}
mutation setAdminActions($input: SetAdminActions!){
setAdminActions(input: $input)
}
{
"input": {
"specs": [
{
"accountID": "string",
"actions": [
"string"
],
"brandIDs": [
"string"
],
"allAction": "boolean"
}
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setAdminActions": "boolean"
}
}
Generate API Key
This endpoint used to generate API Key for given Account
Generate API Key
Mutation to Generate API Key for given account
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation generateAPIKey($input: GenerateAPIKeyInput!){
generateAPIKey(input: $input){
clientId
clientSecret
}
}
Variables
{
"input": {
"accountId": "string"
}
}
mutation generateAPIKey($input: GenerateAPIKeyInput!){
generateAPIKey(input: $input){
clientId
clientSecret
}
}
{
"input": {
"accountId": "string"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"generateAPIKey": {
"clientId": "string",
"clientSecret": "string"
}
}
}
Create Authorization Code
This endpoint used to create authorization Code
Upsert Setting
This endpoint used to upsert setting
Upsert Setting
Mutation to upsert setting
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertSetting($input: UpsertSettingInput!){
upsertSetting(input: $input){
adminEmail
brandID
checkoutAsGuestEnabled
faviconURL
hideFromSearchEngine
reviewsAndRatingEnabled
instagramToken
instagramTokenLastUpdated
websiteDescription
websiteTitle
privyID
notificationCCEmail
defaultExchangePointSettingID
stockReminderEnabled
noReplyEmail
}
}
Variables
{
"input": {
"adminEmail": "string",
"bankAccount": {
"banks": [
{
"name": "string",
"accountNumber": "string",
"accountName": "string",
"isActive": "boolean"
}
]
},
"brandID": "string",
"checkoutAsGuestEnabled": "boolean",
"confirmPaymentMessage": {
"isActive": "boolean",
"message": "string"
},
"faviconURL": "string",
"hideFromSearchEngine": "boolean",
"newsletter": {
"popupOnFirstVisit": "boolean",
"content": "string"
},
"paymentMethods": {
"paymentMethods": [
{
"name": "string",
"merchantID": "string",
"clientKey": "string",
"serverKey": "string",
"acquiringBank": "string",
"payPalAccount": "string",
"specs": [
{
"method": "string",
"isActive": "boolean",
"chargeFeeToCustomer": "boolean",
"expiryHour": "number"
}
]
}
]
},
"productFilterAndSort": {
"filters": [
{
"name": "string",
"isActive": "boolean",
"type": "string",
"variantSpecs": [
{
"key": "string",
"translations": [
{
"language": "string",
"text": "string"
}
],
"options": [
{
"value": "string",
"translations": [
{
"language": "string"
}
]
}
]
}
]
}
]
}
}
}
mutation upsertSetting($input: UpsertSettingInput!){
upsertSetting(input: $input){
adminEmail
brandID
checkoutAsGuestEnabled
faviconURL
hideFromSearchEngine
reviewsAndRatingEnabled
instagramToken
instagramTokenLastUpdated
websiteDescription
websiteTitle
privyID
notificationCCEmail
defaultExchangePointSettingID
stockReminderEnabled
noReplyEmail
}
}
{
"input": {
"adminEmail": "string",
"bankAccount": {
"banks": [
{
"name": "string",
"accountNumber": "string",
"accountName": "string",
"isActive": "boolean"
}
]
},
"brandID": "string",
"checkoutAsGuestEnabled": "boolean",
"confirmPaymentMessage": {
"isActive": "boolean",
"message": "string"
},
"faviconURL": "string",
"hideFromSearchEngine": "boolean",
"newsletter": {
"popupOnFirstVisit": "boolean",
"content": "string"
},
"paymentMethods": {
"paymentMethods": [
{
"name": "string",
"merchantID": "string",
"clientKey": "string",
"serverKey": "string",
"acquiringBank": "string",
"payPalAccount": "string",
"specs": [
{
"method": "string",
"isActive": "boolean",
"chargeFeeToCustomer": "boolean",
"expiryHour": "number"
}
]
}
]
},
"productFilterAndSort": {
"filters": [
{
"name": "string",
"isActive": "boolean",
"type": "string",
"variantSpecs": [
{
"key": "string",
"translations": [
{
"language": "string",
"text": "string"
}
],
"options": [
{
"value": "string",
"translations": [
{
"language": "string"
}
]
}
]
}
]
}
]
}
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertSetting": {
"adminEmail": "string",
"brandID": "string",
"checkoutAsGuestEnabled": "boolean",
"faviconURL": "string",
"hideFromSearchEngine": "boolean",
"reviewsAndRatingEnabled": "boolean",
"instagramToken": "string",
"instagramTokenLastUpdated": "string",
"websiteDescription": "string",
"websiteTitle": "string",
"privyID": "string",
"notificationCCEmail": "string",
"defaultExchangePointSettingID": "string",
"stockReminderEnabled": "boolean",
"noReplyEmail": "string"
}
}
}
Manage Warehouse
This endpoint used to manage warehouse
Create Warehouse
Mutation to create new warehouses
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation createWarehouse($input: CreateWarehouseInput!){
createWarehouse(input: $input){
warehouseID
tenantID
ID
isDefault
}
}
Variables
{
"input": {
"tenantID": "object",
"address": {
"phones": [
"string"
],
"emails": [
"string"
],
"street": "string",
"districtCode": "string",
"postalCode": "string",
"latitude": "number",
"longitude": "number"
}
}
}
mutation createWarehouse($input: CreateWarehouseInput!){
createWarehouse(input: $input){
warehouseID
tenantID
ID
isDefault
}
}
{
"input": {
"tenantID": "object",
"address": {
"phones": [
"string"
],
"emails": [
"string"
],
"street": "string",
"districtCode": "string",
"postalCode": "string",
"latitude": "number",
"longitude": "number"
}
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createWarehouse": {
"warehouseID": "string",
"tenantID": "string",
"ID": "string",
"isDefault": "boolean"
}
}
}
Upsert Warehouse
Mutation to upsert warehouses
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertWarehouse($input: UpsertWarehouseInput!){
upsertWarehouse(input: $input){
warehouseID
tenantID
ID
isDefault
}
}
Variables
{
"input": {
"warehouseID": "object",
"tenantID": "object",
"address": {
"phones": [
"string"
],
"emails": [
"string"
],
"street": "string",
"districtCode": "string",
"postalCode": "string",
"latitude": "number",
"longitude": "number"
}
}
}
mutation upsertWarehouse($input: UpsertWarehouseInput!){
upsertWarehouse(input: $input){
warehouseID
tenantID
ID
isDefault
}
}
{
"input": {
"warehouseID": "object",
"tenantID": "object",
"address": {
"phones": [
"string"
],
"emails": [
"string"
],
"street": "string",
"districtCode": "string",
"postalCode": "string",
"latitude": "number",
"longitude": "number"
}
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertWarehouse": {
"warehouseID": "string",
"tenantID": "string",
"ID": "string",
"isDefault": "boolean"
}
}
}
Set Warehouse as Default
Mutation to set a warehouse as a default
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setWarehouseAsDefault($input: SetWarehouseAsDefaultInput!){
setWarehouseAsDefault(input: $input){
warehouseID
tenantID
ID
isDefault
}
}
Variables
{
"input": {
"warehouseID": "object"
}
}
mutation setWarehouseAsDefault($input: SetWarehouseAsDefaultInput!){
setWarehouseAsDefault(input: $input){
warehouseID
tenantID
ID
isDefault
}
}
{
"input": {
"warehouseID": "object"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setWarehouseAsDefault": {
"warehouseID": "string",
"tenantID": "string",
"ID": "string",
"isDefault": "boolean"
}
}
}
Manage Access Token
This endpoint used to manage access token
Create Access Token
Mutation to grant access token by user credentials or password grant
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation createAccessToken($input: createAccessTokenInput!){
createAccessToken(input: $input){
accountID
accessToken
tenantID
allowedActions
isAdmin
}
}
Variables
{
"input": {
"brandID": "object",
"username": "string",
"password": "string"
}
}
mutation createAccessToken($input: createAccessTokenInput!){
createAccessToken(input: $input){
accountID
accessToken
tenantID
allowedActions
isAdmin
}
}
{
"input": {
"brandID": "object",
"username": "string",
"password": "string"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createAccessToken": {
"accountID": "string",
"accessToken": "string",
"tenantID": "string",
"allowedActions": [
"string"
],
"isAdmin": "boolean"
}
}
}
Remove Access Token
Mutation to revoke access token
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation removeAccessToken($input: removeAccessTokenInput!){
removeAccessToken(input: $input){
accountID
accessToken
tenantID
allowedActions
isAdmin
}
}
Variables
{
"input": {
"accessToken": "string"
}
}
mutation removeAccessToken($input: removeAccessTokenInput!){
removeAccessToken(input: $input){
accountID
accessToken
tenantID
allowedActions
isAdmin
}
}
{
"input": {
"accessToken": "string"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"removeAccessToken": {
"accountID": "string",
"accessToken": "string",
"tenantID": "string",
"allowedActions": [
"string"
],
"isAdmin": "boolean"
}
}
}
Change Authorization Code
This endpoint used to change authorization code into access token
Manage Brands
This endpoint used to manage brands on your store
Create Brand
Mutation to create new barnd
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation createBrand($input: CreateBrandInput!){
createBrand(input: $input){
ID
name
tenantID
logoURL
validCoupons(memberID: $memberID, memberLevel: $memberLevel, items: $items, shippingMethod: $shippingMethod, paymentMethod: $paymentMethod, couponIDs: $couponIDs, date: $date, totalCost: $totalCost)
isExpired
fqdn
googleAdsWebsiteMetaToken
googleAccountLoginURL(redirectURL: $redirectURL)
googleAdsEligibilityStatus
}
}
Variables
{
"input": {
"tenantID": "string",
"name": "string",
"logoURL": "string",
"isActive": "boolean"
}
}
mutation createBrand($input: CreateBrandInput!){
createBrand(input: $input){
ID
name
tenantID
logoURL
validCoupons(memberID: $memberID, memberLevel: $memberLevel, items: $items, shippingMethod: $shippingMethod, paymentMethod: $paymentMethod, couponIDs: $couponIDs, date: $date, totalCost: $totalCost)
isExpired
fqdn
googleAdsWebsiteMetaToken
googleAccountLoginURL(redirectURL: $redirectURL)
googleAdsEligibilityStatus
}
}
{
"input": {
"tenantID": "string",
"name": "string",
"logoURL": "string",
"isActive": "boolean"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createBrand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"logoURL": "string",
"validCoupons": [
null
],
"isExpired": "boolean",
"fqdn": "string",
"googleAdsWebsiteMetaToken": "string",
"googleAccountLoginURL": "string",
"googleAdsEligibilityStatus": "integer"
}
}
}
Upsert Brand
Mutation to upsert brand
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertBrand($input: UpsertBrandInput!){
upsertBrand(input: $input){
ID
name
tenantID
logoURL
validCoupons(memberID: $memberID, memberLevel: $memberLevel, items: $items, shippingMethod: $shippingMethod, paymentMethod: $paymentMethod, couponIDs: $couponIDs, date: $date, totalCost: $totalCost)
isExpired
fqdn
googleAdsWebsiteMetaToken
googleAccountLoginURL(redirectURL: $redirectURL)
googleAdsEligibilityStatus
}
}
Variables
{
"input": {
"brandID": "string",
"tenantID": "string",
"name": "string",
"logoURL": "string",
"isActive": "boolean"
}
}
mutation upsertBrand($input: UpsertBrandInput!){
upsertBrand(input: $input){
ID
name
tenantID
logoURL
validCoupons(memberID: $memberID, memberLevel: $memberLevel, items: $items, shippingMethod: $shippingMethod, paymentMethod: $paymentMethod, couponIDs: $couponIDs, date: $date, totalCost: $totalCost)
isExpired
fqdn
googleAdsWebsiteMetaToken
googleAccountLoginURL(redirectURL: $redirectURL)
googleAdsEligibilityStatus
}
}
{
"input": {
"brandID": "string",
"tenantID": "string",
"name": "string",
"logoURL": "string",
"isActive": "boolean"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertBrand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"logoURL": "string",
"validCoupons": [
null
],
"isExpired": "boolean",
"fqdn": "string",
"googleAdsWebsiteMetaToken": "string",
"googleAccountLoginURL": "string",
"googleAdsEligibilityStatus": "integer"
}
}
}
Activate Brands
Mutation to activate brands
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation activateBrands($input: ActivateBrandInput!){
activateBrands(input: $input){
ID
name
tenantID
logoURL
validCoupons(memberID: $memberID, memberLevel: $memberLevel, items: $items, shippingMethod: $shippingMethod, paymentMethod: $paymentMethod, couponIDs: $couponIDs, date: $date, totalCost: $totalCost)
isExpired
fqdn
googleAdsWebsiteMetaToken
googleAccountLoginURL(redirectURL: $redirectURL)
googleAdsEligibilityStatus
}
}
Variables
{
"input": {
"IDs": [
"object"
]
}
}
mutation activateBrands($input: ActivateBrandInput!){
activateBrands(input: $input){
ID
name
tenantID
logoURL
validCoupons(memberID: $memberID, memberLevel: $memberLevel, items: $items, shippingMethod: $shippingMethod, paymentMethod: $paymentMethod, couponIDs: $couponIDs, date: $date, totalCost: $totalCost)
isExpired
fqdn
googleAdsWebsiteMetaToken
googleAccountLoginURL(redirectURL: $redirectURL)
googleAdsEligibilityStatus
}
}
{
"input": {
"IDs": [
"object"
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"activateBrands": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"logoURL": "string",
"validCoupons": [
null
],
"isExpired": "boolean",
"fqdn": "string",
"googleAdsWebsiteMetaToken": "string",
"googleAccountLoginURL": "string",
"googleAdsEligibilityStatus": "integer"
}
]
}
}
deactivate Brands
Mutation to deactivate brands
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation deactivateBrands($input: DeactivateBrandInput!){
deactivateBrands(input: $input){
ID
name
tenantID
logoURL
validCoupons(memberID: $memberID, memberLevel: $memberLevel, items: $items, shippingMethod: $shippingMethod, paymentMethod: $paymentMethod, couponIDs: $couponIDs, date: $date, totalCost: $totalCost)
isExpired
fqdn
googleAdsWebsiteMetaToken
googleAccountLoginURL(redirectURL: $redirectURL)
googleAdsEligibilityStatus
}
}
Variables
{
"input": {
"IDs": [
"object"
]
}
}
mutation deactivateBrands($input: DeactivateBrandInput!){
deactivateBrands(input: $input){
ID
name
tenantID
logoURL
validCoupons(memberID: $memberID, memberLevel: $memberLevel, items: $items, shippingMethod: $shippingMethod, paymentMethod: $paymentMethod, couponIDs: $couponIDs, date: $date, totalCost: $totalCost)
isExpired
fqdn
googleAdsWebsiteMetaToken
googleAccountLoginURL(redirectURL: $redirectURL)
googleAdsEligibilityStatus
}
}
{
"input": {
"IDs": [
"object"
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deactivateBrands": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"logoURL": "string",
"validCoupons": [
null
],
"isExpired": "boolean",
"fqdn": "string",
"googleAdsWebsiteMetaToken": "string",
"googleAccountLoginURL": "string",
"googleAdsEligibilityStatus": "integer"
}
]
}
}
Bootstrap Brand
Mutation to bootstrap brands
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation bootstrapBrand($input: BootstrapBrandInput!){
bootstrapBrand(input: $input)
}
Variables
{
"input": {
"brandID": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"password": "string",
"phone": "string",
"country": "string",
"districtCode": "string",
"template": "string",
"ssoInfo": {
"idToken": "string",
"provider": "string"
}
}
}
mutation bootstrapBrand($input: BootstrapBrandInput!){
bootstrapBrand(input: $input)
}
{
"input": {
"brandID": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"password": "string",
"phone": "string",
"country": "string",
"districtCode": "string",
"template": "string",
"ssoInfo": {
"idToken": "string",
"provider": "string"
}
}
}
200 OK
Successful operation
type
string
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"bootstrapBrand": "string"
}
}
Manage Payments
This endpoint used to manage payment
Upsert Payment Admin Configs
Mutation to upsert payment providers configuration
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertPaymentAdminConfigs($input: UpsertPaymentAdminConfigsInput!){
upsertPaymentAdminConfigs(input: $input)
}
Variables
{
"input": {
"brandID": "string",
"adminConfigs": [
{
"ID": "string",
"providerID": "string",
"method": "string",
"configs": [
{
"name": "string",
"value": "string"
}
]
}
]
}
}
mutation upsertPaymentAdminConfigs($input: UpsertPaymentAdminConfigsInput!){
upsertPaymentAdminConfigs(input: $input)
}
{
"input": {
"brandID": "string",
"adminConfigs": [
{
"ID": "string",
"providerID": "string",
"method": "string",
"configs": [
{
"name": "string",
"value": "string"
}
]
}
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertPaymentAdminConfigs": "boolean"
}
}
Upsert Payment Enumerated Admin Configs
Mutation to upsert payment config with strong typed configs
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertPaymentEnumeratedAdminConfigs($input: UpsertPaymentEnumeratedAdminConfigsInput!){
upsertPaymentEnumeratedAdminConfigs(input: $input)
}
Variables
{
"input": {
"brandID": "string",
"adminConfigs": [
{
"ID": "string",
"providerID": "string",
"method": "string",
"configs": [
{
"name": "string",
"value": "string"
}
]
}
],
"enableNegativeBankTransferUniqueCode": "boolean"
}
}
mutation upsertPaymentEnumeratedAdminConfigs($input: UpsertPaymentEnumeratedAdminConfigsInput!){
upsertPaymentEnumeratedAdminConfigs(input: $input)
}
{
"input": {
"brandID": "string",
"adminConfigs": [
{
"ID": "string",
"providerID": "string",
"method": "string",
"configs": [
{
"name": "string",
"value": "string"
}
]
}
],
"enableNegativeBankTransferUniqueCode": "boolean"
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertPaymentEnumeratedAdminConfigs": "boolean"
}
}
Insert Payment Confirmation Image
orderID:
string
The ID of the affected order's payment.
imageURL:
string
URL of the payment confirmation image.
amount:
string
The amount of payment.
recipientBankName:
string
The recipient's bank name.
senderEmail:
string
The sender's email.
senderName:
string
The sender's name.
Example
Request Content-Types:
application/json
Query
mutation insertPaymentConfirmationImage($orderID: String!, $imageURL: String!, $amount: String!, $recipientBankName: String!, $senderEmail: String!, $senderName: String!){
insertPaymentConfirmationImage(orderID: $orderID, imageURL: $imageURL, amount: $amount, recipientBankName: $recipientBankName, senderEmail: $senderEmail, senderName: $senderName){
brandID
orderID
provider
method
status
}
}
Variables
{
"orderID": "string",
"imageURL": "string",
"amount": "string",
"recipientBankName": "string",
"senderEmail": "string",
"senderName": "string"
}
mutation insertPaymentConfirmationImage($orderID: String!, $imageURL: String!, $amount: String!, $recipientBankName: String!, $senderEmail: String!, $senderName: String!){
insertPaymentConfirmationImage(orderID: $orderID, imageURL: $imageURL, amount: $amount, recipientBankName: $recipientBankName, senderEmail: $senderEmail, senderName: $senderName){
brandID
orderID
provider
method
status
}
}
{
"orderID": "string",
"imageURL": "string",
"amount": "string",
"recipientBankName": "string",
"senderEmail": "string",
"senderName": "string"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"insertPaymentConfirmationImage": [
{
"brandID": "string",
"orderID": "string",
"provider": "string",
"method": "string",
"status": "string"
}
]
}
}
Payment Confirmation
Mutation to confirm payment for multiple orders
(no description)
Example
Request Content-Types:
application/json
Query
mutation paymentConfirmation($input: PaymentConfirmationUpsertInput!){
paymentConfirmation(input: $input){
brandID
orderID
provider
method
status
}
}
Variables
{
"input": {
"orderID": "string",
"transactionDate": "number",
"senderName": "string",
"amount": "string",
"recipientBankName": "string",
"senderEmail": "string",
"attachment": "string"
}
}
mutation paymentConfirmation($input: PaymentConfirmationUpsertInput!){
paymentConfirmation(input: $input){
brandID
orderID
provider
method
status
}
}
{
"input": {
"orderID": "string",
"transactionDate": "number",
"senderName": "string",
"amount": "string",
"recipientBankName": "string",
"senderEmail": "string",
"attachment": "string"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"paymentConfirmation": [
{
"brandID": "string",
"orderID": "string",
"provider": "string",
"method": "string",
"status": "string"
}
]
}
}
Set Payment Availability
Mutation to upsert payment providers for brand
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setPaymentAvailability($input: SetPaymentAvailabilityInput!){
setPaymentAvailability(input: $input)
}
Variables
{
"input": {
"brandID": "string",
"paymentAvailabilitySpecs": [
{
"providerID": "string",
"isActive": "boolean"
}
]
}
}
mutation setPaymentAvailability($input: SetPaymentAvailabilityInput!){
setPaymentAvailability(input: $input)
}
{
"input": {
"brandID": "string",
"paymentAvailabilitySpecs": [
{
"providerID": "string",
"isActive": "boolean"
}
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setPaymentAvailability": "boolean"
}
}
Generate Payment Link
Mutation to generate new payment link for specified payment providers
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation generatePaymentLink($input: GeneratePaymentLinkInput!){
generatePaymentLink(input: $input){
link
}
}
Variables
{
"input": {
"brandID": "string",
"info": "string",
"method": "string",
"orderID": "string",
"providerID": "string"
}
}
mutation generatePaymentLink($input: GeneratePaymentLinkInput!){
generatePaymentLink(input: $input){
link
}
}
{
"input": {
"brandID": "string",
"info": "string",
"method": "string",
"orderID": "string",
"providerID": "string"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"generatePaymentLink": {
"link": "string"
}
}
}
Manage Articles
This endpoint used to manage artricle on your store
Create Articles
Mutation to create new articles
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation createArticles($input: CreateArticlesInput!){
createArticles(input: $input){
ID
articleID
categoryID
slug
isActive
}
}
Variables
{
"input": {
"brandID": "object",
"specs": [
{
"categoryID": "object",
"slug": "string",
"descriptions": [
{
"language": "string",
"title": "string",
"content": "string"
}
],
"SEOs": [
{
"language": "string",
"title": "string",
"description": "string",
"keywords": [
"string"
]
}
],
"isActive": "boolean"
}
]
}
}
mutation createArticles($input: CreateArticlesInput!){
createArticles(input: $input){
ID
articleID
categoryID
slug
isActive
}
}
{
"input": {
"brandID": "object",
"specs": [
{
"categoryID": "object",
"slug": "string",
"descriptions": [
{
"language": "string",
"title": "string",
"content": "string"
}
],
"SEOs": [
{
"language": "string",
"title": "string",
"description": "string",
"keywords": [
"string"
]
}
],
"isActive": "boolean"
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createArticles": [
{
"ID": "string",
"articleID": "string",
"categoryID": "string",
"slug": "string",
"isActive": "boolean"
}
]
}
}
Delete Articles
Mutation to delete articles
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation deleteArticles($input: DeleteArticlesInput!){
deleteArticles(input: $input)
}
Variables
{
"input": {
"articleIDs": [
"object"
]
}
}
mutation deleteArticles($input: DeleteArticlesInput!){
deleteArticles(input: $input)
}
{
"input": {
"articleIDs": [
"object"
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteArticles": "boolean"
}
}
Set Article Descriptions
Mutation to upsert article's description
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setArticleDescriptions($input: SetArticleDescriptionsInput!){
setArticleDescriptions(input: $input){
ID
articleID
categoryID
slug
isActive
}
}
Variables
{
"input": {
"brandID": "object",
"articleID": "object",
"descriptions": [
{
"language": "string",
"title": "string",
"content": "string"
}
]
}
}
mutation setArticleDescriptions($input: SetArticleDescriptionsInput!){
setArticleDescriptions(input: $input){
ID
articleID
categoryID
slug
isActive
}
}
{
"input": {
"brandID": "object",
"articleID": "object",
"descriptions": [
{
"language": "string",
"title": "string",
"content": "string"
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setArticleDescriptions": {
"ID": "string",
"articleID": "string",
"categoryID": "string",
"slug": "string",
"isActive": "boolean"
}
}
}
Set Article SEO's
Mutation to upsert article's SEO
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setArticleSEOs($input: SetArticleSEOsInput!){
setArticleSEOs(input: $input){
ID
articleID
categoryID
slug
isActive
}
}
Variables
{
"input": {
"brandID": "object",
"articleID": "object",
"SEOs": [
{
"language": "string",
"title": "string",
"description": "string",
"keywords": [
"string"
]
}
]
}
}
mutation setArticleSEOs($input: SetArticleSEOsInput!){
setArticleSEOs(input: $input){
ID
articleID
categoryID
slug
isActive
}
}
{
"input": {
"brandID": "object",
"articleID": "object",
"SEOs": [
{
"language": "string",
"title": "string",
"description": "string",
"keywords": [
"string"
]
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setArticleSEOs": {
"ID": "string",
"articleID": "string",
"categoryID": "string",
"slug": "string",
"isActive": "boolean"
}
}
}
Upsert Articles
Mutation to upsert articles
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertArticles($input: UpsertArticlesInput!){
upsertArticles(input: $input){
ID
articleID
categoryID
slug
isActive
}
}
Variables
{
"input": {
"brandID": "object",
"specs": [
{
"ID": "object",
"categoryID": "object",
"slug": "string",
"descriptions": [
{
"language": "string",
"title": "string",
"content": "string"
}
],
"SEOs": [
{
"language": "string",
"title": "string",
"description": "string",
"keywords": [
"string"
]
}
],
"isActive": "boolean"
}
]
}
}
mutation upsertArticles($input: UpsertArticlesInput!){
upsertArticles(input: $input){
ID
articleID
categoryID
slug
isActive
}
}
{
"input": {
"brandID": "object",
"specs": [
{
"ID": "object",
"categoryID": "object",
"slug": "string",
"descriptions": [
{
"language": "string",
"title": "string",
"content": "string"
}
],
"SEOs": [
{
"language": "string",
"title": "string",
"description": "string",
"keywords": [
"string"
]
}
],
"isActive": "boolean"
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertArticles": [
{
"ID": "string",
"articleID": "string",
"categoryID": "string",
"slug": "string",
"isActive": "boolean"
}
]
}
}
Delete Article Categories
Mutation to delete's article Categories
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation deleteArticleCategories($input: DeleteArticleCategoriesInput!){
deleteArticleCategories(input: $input)
}
Variables
{
"input": {
"brandID": "object",
"categoryIDs": [
"object"
]
}
}
mutation deleteArticleCategories($input: DeleteArticleCategoriesInput!){
deleteArticleCategories(input: $input)
}
{
"input": {
"brandID": "object",
"categoryIDs": [
"object"
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteArticleCategories": "boolean"
}
}
Upsert Article Categories
Mutation to upsert article's Categories
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertArticleCategories($input: UpsertArticleCategoriesInput){
upsertArticleCategories(input: $input){
categoryID
imageURL
isActive
displayType
slug
}
}
Variables
{
"input": {
"brandID": "object",
"specs": [
{
"ID": "object",
"imageURL": "string",
"translations": [
{
"language": "string",
"name": "string"
}
],
"isActive": "boolean",
"SEOs": [
{
"language": "string",
"title": "string",
"description": "string",
"keywords": [
"string"
]
}
],
"displayType": "string",
"slug": "string"
}
]
}
}
mutation upsertArticleCategories($input: UpsertArticleCategoriesInput){
upsertArticleCategories(input: $input){
categoryID
imageURL
isActive
displayType
slug
}
}
{
"input": {
"brandID": "object",
"specs": [
{
"ID": "object",
"imageURL": "string",
"translations": [
{
"language": "string",
"name": "string"
}
],
"isActive": "boolean",
"SEOs": [
{
"language": "string",
"title": "string",
"description": "string",
"keywords": [
"string"
]
}
],
"displayType": "string",
"slug": "string"
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertArticleCategories": [
{
"categoryID": "string",
"imageURL": "string",
"isActive": "boolean",
"slug": "string"
}
]
}
}
Manage Shipping
This endpoint used to manage shipping on your store
Upsert Shipping methods
Mutation to upsert shipping methods
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertShippings($input: UpsertShippingsInput!){
upsertShippings(input: $input){
brandID
ID
provider
isActive
}
}
Variables
{
"input": {
"brandID": "object",
"specs": [
{
"ID": "object",
"provider": "string",
"services": [
{
"ID": "object",
"name": "string",
"isActive": "boolean",
"isAutoAWB": "boolean",
"useInsurance": "boolean"
}
],
"isActive": "boolean"
}
]
}
}
mutation upsertShippings($input: UpsertShippingsInput!){
upsertShippings(input: $input){
brandID
ID
provider
isActive
}
}
{
"input": {
"brandID": "object",
"specs": [
{
"ID": "object",
"provider": "string",
"services": [
{
"ID": "object",
"name": "string",
"isActive": "boolean",
"isAutoAWB": "boolean",
"useInsurance": "boolean"
}
],
"isActive": "boolean"
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertShippings": [
{
"brandID": "string",
"ID": "string",
"provider": "string",
"isActive": "boolean"
}
]
}
}
Delete Shipping methods
Mutation to delete shipping methods
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation deleteShippings($input: DeleteShippingInput!){
deleteShippings(input: $input){
brandID
ID
provider
isActive
}
}
Variables
{
"input": {
"IDs": [
"object"
]
}
}
mutation deleteShippings($input: DeleteShippingInput!){
deleteShippings(input: $input){
brandID
ID
provider
isActive
}
}
{
"input": {
"IDs": [
"object"
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteShippings": [
{
"brandID": "string",
"ID": "string",
"provider": "string",
"isActive": "boolean"
}
]
}
}
Set Shippings Status
Mutation ro set activate or deactivate shipping methods
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setShippingsStatus($input: SetShippingsStatusInput!){
setShippingsStatus(input: $input){
brandID
ID
provider
isActive
}
}
Variables
{
"input": {
"IDs": [
"object"
],
"isActive": "boolean"
}
}
mutation setShippingsStatus($input: SetShippingsStatusInput!){
setShippingsStatus(input: $input){
brandID
ID
provider
isActive
}
}
{
"input": {
"IDs": [
"object"
],
"isActive": "boolean"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setShippingsStatus": [
{
"brandID": "string",
"ID": "string",
"provider": "string",
"isActive": "boolean"
}
]
}
}
Manage Cart
This endpoint used to manage cart on your store
Save Cart
Mutation to save current or update or update existing cart
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation saveCart($input: SaveCartReq!){
saveCart(input: $input){
brandID
channelID
ID
memberID
memberLevel
}
}
Variables
{
"input": {
"billingAddress": {
"districtCode": "string",
"email": "string",
"name": "string",
"phone": "string",
"postalCode": "string",
"street": "string",
"longLat": "string"
},
"brandID": "string",
"cartID": "string",
"channelID": "string",
"couponIDs": [
"string"
],
"deliveryAddress": {
"districtCode": "string",
"email": "string",
"name": "string",
"phone": "string",
"postalCode": "string",
"street": "string",
"longLat": "string"
},
"lineItems": [
{
"imageURL": "string",
"price": {
"code": "string",
"value": "number"
},
"quantity": "number",
"SKU": "string",
"title": "string"
}
],
"payment": {
"fee": {
"code": "string",
"value": "number"
},
"provider": "string",
"service": "string",
"uniqueCode": "number"
},
"shipping": {
"awbNumber": "string",
"cost": {
"code": "string",
"value": "number"
},
"provider": "string",
"service": "string"
},
"removeCoupons": "boolean",
"isCouponRemoved": "boolean",
"isLineItemsRemoved": "boolean"
}
}
mutation saveCart($input: SaveCartReq!){
saveCart(input: $input){
brandID
channelID
ID
memberID
memberLevel
}
}
{
"input": {
"billingAddress": {
"districtCode": "string",
"email": "string",
"name": "string",
"phone": "string",
"postalCode": "string",
"street": "string",
"longLat": "string"
},
"brandID": "string",
"cartID": "string",
"channelID": "string",
"couponIDs": [
"string"
],
"deliveryAddress": {
"districtCode": "string",
"email": "string",
"name": "string",
"phone": "string",
"postalCode": "string",
"street": "string",
"longLat": "string"
},
"lineItems": [
{
"imageURL": "string",
"price": {
"code": "string",
"value": "number"
},
"quantity": "number",
"SKU": "string",
"title": "string"
}
],
"payment": {
"fee": {
"code": "string",
"value": "number"
},
"provider": "string",
"service": "string",
"uniqueCode": "number"
},
"shipping": {
"awbNumber": "string",
"cost": {
"code": "string",
"value": "number"
},
"provider": "string",
"service": "string"
},
"removeCoupons": "boolean",
"isCouponRemoved": "boolean",
"isLineItemsRemoved": "boolean"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"saveCart": {
"brandID": "string",
"channelID": "string",
"ID": "string",
"memberID": "string",
"memberLevel": "string"
}
}
}
Save Cart By Member ID
Mutation to save current or update existing cart by memberID
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation saveCartByMemberID($input: SaveCartByMemberIDReq!){
saveCartByMemberID(input: $input){
brandID
channelID
ID
memberID
memberLevel
}
}
Variables
{
"input": {
"billingAddress": {
"districtCode": "string",
"email": "string",
"name": "string",
"phone": "string",
"postalCode": "string",
"street": "string",
"longLat": "string"
},
"brandID": "string",
"channelID": "string",
"memberLevel": "string",
"membershipId": "string",
"couponIDs": [
"string"
],
"deliveryAddress": {
"districtCode": "string",
"email": "string",
"name": "string",
"phone": "string",
"postalCode": "string",
"street": "string",
"longLat": "string"
},
"lineItems": [
{
"imageURL": "string",
"price": {
"code": "string",
"value": "number"
},
"quantity": "number",
"SKU": "string",
"title": "string"
}
],
"memberID": "string",
"payment": {
"fee": {
"code": "string",
"value": "number"
},
"provider": "string",
"service": "string",
"uniqueCode": "number"
},
"shipping": {
"awbNumber": "string",
"cost": {
"code": "string",
"value": "number"
},
"provider": "string",
"service": "string"
},
"cartID": "string",
"removeCoupons": "boolean",
"isCouponRemoved": "boolean"
}
}
mutation saveCartByMemberID($input: SaveCartByMemberIDReq!){
saveCartByMemberID(input: $input){
brandID
channelID
ID
memberID
memberLevel
}
}
{
"input": {
"billingAddress": {
"districtCode": "string",
"email": "string",
"name": "string",
"phone": "string",
"postalCode": "string",
"street": "string",
"longLat": "string"
},
"brandID": "string",
"channelID": "string",
"memberLevel": "string",
"membershipId": "string",
"couponIDs": [
"string"
],
"deliveryAddress": {
"districtCode": "string",
"email": "string",
"name": "string",
"phone": "string",
"postalCode": "string",
"street": "string",
"longLat": "string"
},
"lineItems": [
{
"imageURL": "string",
"price": {
"code": "string",
"value": "number"
},
"quantity": "number",
"SKU": "string",
"title": "string"
}
],
"memberID": "string",
"payment": {
"fee": {
"code": "string",
"value": "number"
},
"provider": "string",
"service": "string",
"uniqueCode": "number"
},
"shipping": {
"awbNumber": "string",
"cost": {
"code": "string",
"value": "number"
},
"provider": "string",
"service": "string"
},
"cartID": "string",
"removeCoupons": "boolean",
"isCouponRemoved": "boolean"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"saveCartByMemberID": {
"brandID": "string",
"channelID": "string",
"ID": "string",
"memberID": "string",
"memberLevel": "string"
}
}
}
Upsert Cart Item
Mutation to upsert Cart Item
sellerId:
string
(no description)
buyerId:
string
(no description)
sku:
string
(no description)
quantity:
integer
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertCartItem($sellerId: String!, $buyerId: String!, $sku: String!, $quantity: Int!){
upsertCartItem(sellerId: $sellerId, buyerId: $buyerId, sku: $sku, quantity: $quantity){
sellerId
buyerId
}
}
Variables
{
"sellerId": "string",
"buyerId": "string",
"sku": "string",
"quantity": "integer"
}
mutation upsertCartItem($sellerId: String!, $buyerId: String!, $sku: String!, $quantity: Int!){
upsertCartItem(sellerId: $sellerId, buyerId: $buyerId, sku: $sku, quantity: $quantity){
sellerId
buyerId
}
}
{
"sellerId": "string",
"buyerId": "string",
"sku": "string",
"quantity": "integer"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertCartItem": {
"sellerId": "string",
"buyerId": "string"
}
}
}
Clear Cart
Mutation to clear Cart
sellerId:
string
(no description)
buyerId:
string
(no description)
Example
Request Content-Types:
application/json
Query
mutation clearCart($sellerId: String!, $buyerId: String!){
clearCart(sellerId: $sellerId, buyerId: $buyerId){
sellerId
buyerId
}
}
Variables
{
"sellerId": "string",
"buyerId": "string"
}
mutation clearCart($sellerId: String!, $buyerId: String!){
clearCart(sellerId: $sellerId, buyerId: $buyerId){
sellerId
buyerId
}
}
{
"sellerId": "string",
"buyerId": "string"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"clearCart": {
"sellerId": "string",
"buyerId": "string"
}
}
}
Manage Discounts
This endpoint used to manage disconuts
Delete Discount
Mutation to delete discount
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation deleteDiscounts($input: DeleteDiscountsInput!){
deleteDiscounts(input: $input)
}
Variables
{
"input": {
"IDs": [
"object"
]
}
}
mutation deleteDiscounts($input: DeleteDiscountsInput!){
deleteDiscounts(input: $input)
}
{
"input": {
"IDs": [
"object"
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteDiscounts": "boolean"
}
}
Set Discounts As Active
Mutation to set Discount As Active
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setDiscountsAsActive($input: SetDiscountsAsActiveInput!){
setDiscountsAsActive(input: $input)
}
Variables
{
"input": {
"IDs": [
"object"
]
}
}
mutation setDiscountsAsActive($input: SetDiscountsAsActiveInput!){
setDiscountsAsActive(input: $input)
}
{
"input": {
"IDs": [
"object"
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setDiscountsAsActive": "boolean"
}
}
Set Discount As In Active
Mutation to set Discount as in active
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setDiscountsAsInactive($input: SetDiscountsAsInactiveInput!){
setDiscountsAsInactive(input: $input)
}
Variables
{
"input": {
"IDs": [
"object"
]
}
}
mutation setDiscountsAsInactive($input: SetDiscountsAsInactiveInput!){
setDiscountsAsInactive(input: $input)
}
{
"input": {
"IDs": [
"object"
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setDiscountsAsInactive": "boolean"
}
}
Set Discount Rows
Mutation to set discount rows
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setDiscountRows($input: SetDiscountsRowsInput!){
setDiscountRows(input: $input){
brandID
discountID
channelIDs
title
}
}
Variables
{
"input": {
"discountID": "object",
"rows": [
{
"referenceID": "object",
"discountType": "string",
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number"
}
]
}
}
mutation setDiscountRows($input: SetDiscountsRowsInput!){
setDiscountRows(input: $input){
brandID
discountID
channelIDs
title
}
}
{
"input": {
"discountID": "object",
"rows": [
{
"referenceID": "object",
"discountType": "string",
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number"
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setDiscountRows": {
"brandID": "string",
"discountID": "string",
"channelIDs": [
"string"
],
"title": "string"
}
}
}
Upsert Discount
Mutation to upsert Discounts
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertDiscounts($input: UpsertDiscountsInput!){
upsertDiscounts(input: $input){
brandID
discountID
channelIDs
title
}
}
Variables
{
"input": {
"brandID": "object",
"specs": [
{
"ID": "object",
"channelIDs": [
"object"
],
"title": "string",
"startDate": "number",
"endDate": "number",
"isActive": "boolean",
"referenceType": "string",
"maxItem": "number",
"rows": [
{
"referenceID": "object",
"discountType": "string",
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number"
}
]
}
]
}
}
mutation upsertDiscounts($input: UpsertDiscountsInput!){
upsertDiscounts(input: $input){
brandID
discountID
channelIDs
title
}
}
{
"input": {
"brandID": "object",
"specs": [
{
"ID": "object",
"channelIDs": [
"object"
],
"title": "string",
"startDate": "number",
"endDate": "number",
"isActive": "boolean",
"referenceType": "string",
"maxItem": "number",
"rows": [
{
"referenceID": "object",
"discountType": "string",
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number"
}
]
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertDiscounts": [
{
"brandID": "string",
"discountID": "string",
"channelIDs": [
"string"
],
"title": "string"
}
]
}
}
Manage Widgets
This endpoint used to manage widgets
Upsert Widgets
Mutation to upsert widgets
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertWidgets($input: UpsertWidgetInput!){
upsertWidgets(input: $input){
ID
name
region
order
content
published
}
}
Variables
{
"input": {
"brandID": "object",
"specs": [
{
"ID": "object",
"content": "string",
"name": "string",
"order": "number",
"published": "boolean",
"region": "string"
}
]
}
}
mutation upsertWidgets($input: UpsertWidgetInput!){
upsertWidgets(input: $input){
ID
name
region
order
content
published
}
}
{
"input": {
"brandID": "object",
"specs": [
{
"ID": "object",
"content": "string",
"name": "string",
"order": "number",
"published": "boolean",
"region": "string"
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertWidgets": [
{
"ID": "string",
"name": "string",
"region": "string",
"order": "integer",
"content": "string",
"published": "boolean"
}
]
}
}
Create Widgets
Mutation to create widgets
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation createWidgets($input: CreateWidgetInput!){
createWidgets(input: $input){
ID
name
region
order
content
published
}
}
Variables
{
"input": {
"brandID": "object",
"specs": [
{
"region": "string",
"order": "number",
"name": "string",
"content": "string",
"published": "boolean"
}
]
}
}
mutation createWidgets($input: CreateWidgetInput!){
createWidgets(input: $input){
ID
name
region
order
content
published
}
}
{
"input": {
"brandID": "object",
"specs": [
{
"region": "string",
"order": "number",
"name": "string",
"content": "string",
"published": "boolean"
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createWidgets": [
{
"ID": "string",
"name": "string",
"region": "string",
"order": "integer",
"content": "string",
"published": "boolean"
}
]
}
}
Publish Widgets
Mutation to publish widgets
IDs:
string[]
(no description)
Example
Request Content-Types:
application/json
Query
mutation publishWidget($IDs: [ID!]!){
publishWidget(IDs: $IDs){
ID
name
region
order
content
published
}
}
Variables
{
"IDs": [
"string"
]
}
mutation publishWidget($IDs: [ID!]!){
publishWidget(IDs: $IDs){
ID
name
region
order
content
published
}
}
{
"IDs": [
"string"
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"publishWidget": [
{
"ID": "string",
"name": "string",
"region": "string",
"order": "integer",
"content": "string",
"published": "boolean"
}
]
}
}
Unpublish Widgets
Mutation to unpublish widgets
IDs:
string[]
(no description)
Example
Request Content-Types:
application/json
Query
mutation unpublishWidget($IDs: [ID!]!){
unpublishWidget(IDs: $IDs){
ID
name
region
order
content
published
}
}
Variables
{
"IDs": [
"string"
]
}
mutation unpublishWidget($IDs: [ID!]!){
unpublishWidget(IDs: $IDs){
ID
name
region
order
content
published
}
}
{
"IDs": [
"string"
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"unpublishWidget": [
{
"ID": "string",
"name": "string",
"region": "string",
"order": "integer",
"content": "string",
"published": "boolean"
}
]
}
}
Reorder Widget
Reorder widget based on order of widget in input
IDs:
string[]
List of widget IDs to be reordered.
Example
Request Content-Types:
application/json
Query
mutation reorderWidget($IDs: [ID!]!){
reorderWidget(IDs: $IDs){
ID
name
region
order
content
published
}
}
Variables
{
"IDs": [
"string"
]
}
mutation reorderWidget($IDs: [ID!]!){
reorderWidget(IDs: $IDs){
ID
name
region
order
content
published
}
}
{
"IDs": [
"string"
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"reorderWidget": [
{
"ID": "string",
"name": "string",
"region": "string",
"order": "integer",
"content": "string",
"published": "boolean"
}
]
}
}
Delete Widgets
Mutation to delete widgets
IDs:
string[]
(no description)
Example
Request Content-Types:
application/json
Query
mutation deleteWidgets($IDs: [ID!]!){
deleteWidgets(IDs: $IDs)
}
Variables
{
"IDs": [
"string"
]
}
mutation deleteWidgets($IDs: [ID!]!){
deleteWidgets(IDs: $IDs)
}
{
"IDs": [
"string"
]
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteWidgets": "boolean"
}
}
Manage Lookbooks
This endpoint used to manage Lookbooks
Create Lookbooks
Mutation to create Lookbooks
brandID:
string
(no description)
specs:
(no description)
Example
Request Content-Types:
application/json
Query
mutation createLookbooks($brandID: ID!, $specs: [CreateLookbookInput!]!){
createLookbooks(brandID: $brandID, specs: $specs){
ID
brandID
imageURL
name
isActive
slug
}
}
Variables
{
"brandID": "string",
"specs": [
{
"imageURL": "string",
"name": "string",
"language": "string"
}
]
}
mutation createLookbooks($brandID: ID!, $specs: [CreateLookbookInput!]!){
createLookbooks(brandID: $brandID, specs: $specs){
ID
brandID
imageURL
name
isActive
slug
}
}
{
"brandID": "string",
"specs": [
{
"imageURL": "string",
"name": "string",
"language": "string"
}
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createLookbooks": [
{
"ID": "string",
"brandID": "string",
"imageURL": "string",
"name": "string",
"isActive": "boolean",
"slug": "string"
}
]
}
}
Upsert Lookbooks
Mutation to upsert Lookbooks
brandID:
string
(no description)
specs:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertLookbooks($brandID: ID!, $specs: [UpsertLookbookInput!]!){
upsertLookbooks(brandID: $brandID, specs: $specs){
ID
brandID
imageURL
name
isActive
slug
}
}
Variables
{
"brandID": "string",
"specs": [
{
"ID": "object",
"imageURL": "string",
"name": "string",
"language": "string"
}
]
}
mutation upsertLookbooks($brandID: ID!, $specs: [UpsertLookbookInput!]!){
upsertLookbooks(brandID: $brandID, specs: $specs){
ID
brandID
imageURL
name
isActive
slug
}
}
{
"brandID": "string",
"specs": [
{
"ID": "object",
"imageURL": "string",
"name": "string",
"language": "string"
}
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertLookbooks": [
{
"ID": "string",
"brandID": "string",
"imageURL": "string",
"name": "string",
"isActive": "boolean",
"slug": "string"
}
]
}
}
Delete Lookbooks
Mutation to delete lookbook images
brandID:
string
(no description)
lookbookIDs:
string[]
(no description)
Example
Request Content-Types:
application/json
Query
mutation deleteLookbooks($brandID: ID!, $lookbookIDs: [ID!]!){
deleteLookbooks(brandID: $brandID, lookbookIDs: $lookbookIDs)
}
Variables
{
"brandID": "string",
"lookbookIDs": [
"string"
]
}
mutation deleteLookbooks($brandID: ID!, $lookbookIDs: [ID!]!){
deleteLookbooks(brandID: $brandID, lookbookIDs: $lookbookIDs)
}
{
"brandID": "string",
"lookbookIDs": [
"string"
]
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteLookbooks": "boolean"
}
}
Delete Lookbook Images
Mutation to delete lookbook image URL's
brandID:
string
(no description)
lookbookID:
string
(no description)
imageURLs:
string[]
(no description)
Example
Request Content-Types:
application/json
Query
mutation deleteLookbookImages($brandID: ID!, $lookbookID: ID!, $imageURLs: [String!]!){
deleteLookbookImages(brandID: $brandID, lookbookID: $lookbookID, imageURLs: $imageURLs){
ID
brandID
imageURL
name
isActive
slug
}
}
Variables
{
"brandID": "string",
"lookbookID": "string",
"imageURLs": [
"string"
]
}
mutation deleteLookbookImages($brandID: ID!, $lookbookID: ID!, $imageURLs: [String!]!){
deleteLookbookImages(brandID: $brandID, lookbookID: $lookbookID, imageURLs: $imageURLs){
ID
brandID
imageURL
name
isActive
slug
}
}
{
"brandID": "string",
"lookbookID": "string",
"imageURLs": [
"string"
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteLookbookImages": {
"ID": "string",
"brandID": "string",
"imageURL": "string",
"name": "string",
"isActive": "boolean",
"slug": "string"
}
}
}
Set Lookbook Images
Mutation to set lookbook Images
brandID:
string
(no description)
lookbookID:
string
(no description)
images:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setLookbookImages($brandID: ID!, $lookbookID: ID!, $images: [LookbookImageInput!]!){
setLookbookImages(brandID: $brandID, lookbookID: $lookbookID, images: $images){
ID
brandID
imageURL
name
isActive
slug
}
}
Variables
{
"brandID": "string",
"lookbookID": "string",
"images": [
{
"URL": "string",
"title": "string",
"language": "string"
}
]
}
mutation setLookbookImages($brandID: ID!, $lookbookID: ID!, $images: [LookbookImageInput!]!){
setLookbookImages(brandID: $brandID, lookbookID: $lookbookID, images: $images){
ID
brandID
imageURL
name
isActive
slug
}
}
{
"brandID": "string",
"lookbookID": "string",
"images": [
{
"URL": "string",
"title": "string",
"language": "string"
}
]
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setLookbookImages": {
"ID": "string",
"brandID": "string",
"imageURL": "string",
"name": "string",
"isActive": "boolean",
"slug": "string"
}
}
}
Manage Notifaction Templates V2
This endpoint used to manage notification template V2
Upsert Notification Templates V2
Base method to upsert templates related to notification V2 template
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertNotificationTemplatesV2($input: UpsertTemplatesInputV2!){
upsertNotificationTemplatesV2(input: $input){
ID
type
version
isActive
}
}
Variables
{
"input": {
"brandID": "object",
"specs": [
{
"ID": "object",
"event": {
"type": "string",
"version": "number"
},
"emailTemplate": {
"buyer": {
"bccs": [
"string"
],
"ccs": [
"string"
],
"tos": [
"string"
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
},
"isActive": "boolean",
"seller": {
"bccs": [
"string"
],
"ccs": [
"string"
],
"tos": [
"string"
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
}
},
"smsTemplate": {
"buyer": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
},
"isActive": "boolean",
"seller": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
}
},
"whatsAppTemplate": {
"buyer": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string"
}
]
}
}
}
]
}
}
mutation upsertNotificationTemplatesV2($input: UpsertTemplatesInputV2!){
upsertNotificationTemplatesV2(input: $input){
ID
type
version
isActive
}
}
{
"input": {
"brandID": "object",
"specs": [
{
"ID": "object",
"event": {
"type": "string",
"version": "number"
},
"emailTemplate": {
"buyer": {
"bccs": [
"string"
],
"ccs": [
"string"
],
"tos": [
"string"
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
},
"isActive": "boolean",
"seller": {
"bccs": [
"string"
],
"ccs": [
"string"
],
"tos": [
"string"
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
}
},
"smsTemplate": {
"buyer": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
},
"isActive": "boolean",
"seller": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
}
},
"whatsAppTemplate": {
"buyer": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string"
}
]
}
}
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertNotificationTemplatesV2": [
{
"ID": "string",
"version": "string",
"isActive": "boolean"
}
]
}
}
Create Notification Templates V2
Base method to create notification templates V2
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation createNotificationTemplatesV2($input: CreateTemplateInput!){
createNotificationTemplatesV2(input: $input){
ID
type
version
isActive
}
}
Variables
{
"input": {
"brandID": "object",
"specs": [
{
"emailTemplate": {
"buyer": {
"bccs": [
"string"
],
"ccs": [
"string"
],
"tos": [
"string"
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
},
"isActive": "boolean",
"seller": {
"bccs": [
"string"
],
"ccs": [
"string"
],
"tos": [
"string"
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
}
},
"event": {
"type": "string",
"version": "number"
},
"smsTemplate": {
"buyer": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
},
"isActive": "boolean",
"seller": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
}
},
"whatsAppTemplate": {
"buyer": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
}
}
}
]
}
}
mutation createNotificationTemplatesV2($input: CreateTemplateInput!){
createNotificationTemplatesV2(input: $input){
ID
type
version
isActive
}
}
{
"input": {
"brandID": "object",
"specs": [
{
"emailTemplate": {
"buyer": {
"bccs": [
"string"
],
"ccs": [
"string"
],
"tos": [
"string"
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
},
"isActive": "boolean",
"seller": {
"bccs": [
"string"
],
"ccs": [
"string"
],
"tos": [
"string"
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
}
},
"event": {
"type": "string",
"version": "number"
},
"smsTemplate": {
"buyer": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
},
"isActive": "boolean",
"seller": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
}
},
"whatsAppTemplate": {
"buyer": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
}
}
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createNotificationTemplatesV2": [
{
"ID": "string",
"version": "string",
"isActive": "boolean"
}
]
}
}
Activate Notification Templates V2
Base method to activate Notification Templates V2
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation activateNotificationTemplatesV2($input: ActivateTemplateInput!){
activateNotificationTemplatesV2(input: $input){
ID
type
version
isActive
}
}
Variables
{
"input": {
"email": "boolean",
"sms": "boolean",
"whatsApp": "boolean",
"IDs": [
"string"
]
}
}
mutation activateNotificationTemplatesV2($input: ActivateTemplateInput!){
activateNotificationTemplatesV2(input: $input){
ID
type
version
isActive
}
}
{
"input": {
"email": "boolean",
"sms": "boolean",
"whatsApp": "boolean",
"IDs": [
"string"
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"activateNotificationTemplatesV2": [
{
"ID": "string",
"version": "string",
"isActive": "boolean"
}
]
}
}
Deactivate Notification Templates V2
Base method to deactivate notification templates V2
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation deactivateNotificationTemplatesV2($input: DeactivateTemplateInput!){
deactivateNotificationTemplatesV2(input: $input){
ID
type
version
isActive
}
}
Variables
{
"input": {
"email": "boolean",
"sms": "boolean",
"whatsApp": "boolean",
"IDs": [
"string"
]
}
}
mutation deactivateNotificationTemplatesV2($input: DeactivateTemplateInput!){
deactivateNotificationTemplatesV2(input: $input){
ID
type
version
isActive
}
}
{
"input": {
"email": "boolean",
"sms": "boolean",
"whatsApp": "boolean",
"IDs": [
"string"
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deactivateNotificationTemplatesV2": [
{
"ID": "string",
"version": "string",
"isActive": "boolean"
}
]
}
}
Delete Notification Templates V2
Base method to delete notification templates V2
(no description)
Example
Request Content-Types:
application/json
Query
mutation deleteNotificationTemplatesV2($input: DeleteNotificationTemplatesInput!){
deleteNotificationTemplatesV2(input: $input)
}
Variables
{
"input": {
"IDs": [
"object"
]
}
}
mutation deleteNotificationTemplatesV2($input: DeleteNotificationTemplatesInput!){
deleteNotificationTemplatesV2(input: $input)
}
{
"input": {
"IDs": [
"object"
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteNotificationTemplatesV2": "boolean"
}
}
Manage Bundles
This endpoint used to manage bundles
Upsert Buy n item bundle
Base method Upsert Buy n item get fixed price bundles
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertBuyNItemBundle($input: UpsertBuyNItemBundleInput!){
upsertBuyNItemBundle(input: $input)
}
Variables
{
"input": {
"brandID": "object",
"bundles": [
{
"ID": "string",
"title": "string",
"startTime": "number",
"endTime": "number",
"isActive": "boolean",
"priority": "number",
"numOfItemToBuy": "number",
"eligibleProductIDs": [
"string"
],
"fixedPrice": {
"code": "string",
"value": "number"
}
}
]
}
}
mutation upsertBuyNItemBundle($input: UpsertBuyNItemBundleInput!){
upsertBuyNItemBundle(input: $input)
}
{
"input": {
"brandID": "object",
"bundles": [
{
"ID": "string",
"title": "string",
"startTime": "number",
"endTime": "number",
"isActive": "boolean",
"priority": "number",
"numOfItemToBuy": "number",
"eligibleProductIDs": [
"string"
],
"fixedPrice": {
"code": "string",
"value": "number"
}
}
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertBuyNItemBundle": "boolean"
}
}
Upsert Buy Min Quantity Get Free Items bundle
Base method to upsert buy minimum quantity get free products bundles
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertBuyMinQuantityGetFreeItemsBundle($input: UpsertBuyMinQuantityGetFreeItemsBundleInput!){
upsertBuyMinQuantityGetFreeItemsBundle(input: $input)
}
Variables
{
"input": {
"brandID": "object",
"bundles": [
{
"ID": "string",
"title": "string",
"startTime": "number",
"endTime": "number",
"isActive": "boolean",
"priority": "number",
"minQuantityToBuy": "number",
"eligibleProductIDs": [
"string"
],
"bundledProducts": [
{
"ID": "string",
"price": {
"code": "string",
"value": "number"
},
"quantity": "number"
}
]
}
]
}
}
mutation upsertBuyMinQuantityGetFreeItemsBundle($input: UpsertBuyMinQuantityGetFreeItemsBundleInput!){
upsertBuyMinQuantityGetFreeItemsBundle(input: $input)
}
{
"input": {
"brandID": "object",
"bundles": [
{
"ID": "string",
"title": "string",
"startTime": "number",
"endTime": "number",
"isActive": "boolean",
"priority": "number",
"minQuantityToBuy": "number",
"eligibleProductIDs": [
"string"
],
"bundledProducts": [
{
"ID": "string",
"price": {
"code": "string",
"value": "number"
},
"quantity": "number"
}
]
}
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertBuyMinQuantityGetFreeItemsBundle": "boolean"
}
}
Upsert Buy Min Amount Get Free Items Bundle
Base method to upsert buy min amount get free products bundles
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertBuyMinAmountGetFreeItemsBundle($input: UpsertBuyMinAmountGetFreeItemsBundleInput!){
upsertBuyMinAmountGetFreeItemsBundle(input: $input)
}
Variables
{
"input": {
"brandID": "object",
"bundles": [
{
"ID": "string",
"title": "string",
"startTime": "number",
"endTime": "number",
"isActive": "boolean",
"priority": "number",
"minAmountToBuy": {
"code": "string",
"value": "number"
},
"eligibleProductIDs": [
"string"
],
"bundledProducts": [
{
"ID": "string",
"price": {
"code": "string",
"value": "number"
},
"quantity": "number"
}
]
}
]
}
}
mutation upsertBuyMinAmountGetFreeItemsBundle($input: UpsertBuyMinAmountGetFreeItemsBundleInput!){
upsertBuyMinAmountGetFreeItemsBundle(input: $input)
}
{
"input": {
"brandID": "object",
"bundles": [
{
"ID": "string",
"title": "string",
"startTime": "number",
"endTime": "number",
"isActive": "boolean",
"priority": "number",
"minAmountToBuy": {
"code": "string",
"value": "number"
},
"eligibleProductIDs": [
"string"
],
"bundledProducts": [
{
"ID": "string",
"price": {
"code": "string",
"value": "number"
},
"quantity": "number"
}
]
}
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertBuyMinAmountGetFreeItemsBundle": "boolean"
}
}
Delete Bundles
Base method to delete bundles
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation deleteBundles($input: DeleteBundlesInput!){
deleteBundles(input: $input)
}
Variables
{
"input": {
"brandID": "string",
"IDs": [
"object"
]
}
}
mutation deleteBundles($input: DeleteBundlesInput!){
deleteBundles(input: $input)
}
{
"input": {
"brandID": "string",
"IDs": [
"object"
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteBundles": "boolean"
}
}
Manage Coupons
This endpount used to manage coupons
Upsert Product Coupon
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertProductCoupon($input: UpsertProductCouponsInput!){
upsertProductCoupon(input: $input)
}
Variables
{
"input": {
"brandID": "object",
"specs": [
{
"ID": "object",
"code": "string",
"title": "string",
"isActive": "boolean",
"salesChannel": "string",
"discountValue": {
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number",
"maximumDiscountValue": {
"code": "string",
"value": "number"
},
"discountType": "string",
"discountField": "string"
},
"maximumUsageCount": "number",
"applicableSKUs": [
"string"
],
"applicableStartTimestamp": "number",
"applicableEndTimestamp": "number",
"isMemberOnly": "boolean",
"allowedMemberLevels": [
"string"
],
"minimumPurchase": {
"code": "string",
"value": "number"
}
}
]
}
}
mutation upsertProductCoupon($input: UpsertProductCouponsInput!){
upsertProductCoupon(input: $input)
}
{
"input": {
"brandID": "object",
"specs": [
{
"ID": "object",
"code": "string",
"title": "string",
"isActive": "boolean",
"salesChannel": "string",
"discountValue": {
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number",
"maximumDiscountValue": {
"code": "string",
"value": "number"
},
"discountType": "string",
"discountField": "string"
},
"maximumUsageCount": "number",
"applicableSKUs": [
"string"
],
"applicableStartTimestamp": "number",
"applicableEndTimestamp": "number",
"isMemberOnly": "boolean",
"allowedMemberLevels": [
"string"
],
"minimumPurchase": {
"code": "string",
"value": "number"
}
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertProductCoupon": [
null
]
}
}
Upsert Cart Coupon
Base method to upsert cart coupons
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertCartCoupon($input: UpsertCartCouponsInput!){
upsertCartCoupon(input: $input)
}
Variables
{
"input": {
"brandID": "object",
"specs": [
{
"ID": "object",
"code": "string",
"title": "string",
"isActive": "boolean",
"salesChannel": "string",
"discountValue": {
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number",
"maximumDiscountValue": {
"code": "string",
"value": "number"
},
"discountType": "string",
"discountField": "string"
},
"maximumUsageCount": "number",
"applicableStartTimestamp": "number",
"applicableEndTimestamp": "number",
"isMemberOnly": "boolean",
"allowedMemberLevels": [
"string"
],
"minimumPurchase": {
"code": "string",
"value": "number"
}
}
]
}
}
mutation upsertCartCoupon($input: UpsertCartCouponsInput!){
upsertCartCoupon(input: $input)
}
{
"input": {
"brandID": "object",
"specs": [
{
"ID": "object",
"code": "string",
"title": "string",
"isActive": "boolean",
"salesChannel": "string",
"discountValue": {
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number",
"maximumDiscountValue": {
"code": "string",
"value": "number"
},
"discountType": "string",
"discountField": "string"
},
"maximumUsageCount": "number",
"applicableStartTimestamp": "number",
"applicableEndTimestamp": "number",
"isMemberOnly": "boolean",
"allowedMemberLevels": [
"string"
],
"minimumPurchase": {
"code": "string",
"value": "number"
}
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertCartCoupon": [
null
]
}
}
Upsert Shipping Coupon
Base method to upsert shipping coupon
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertShippingCoupon($input: UpsertShippingCouponsInput!){
upsertShippingCoupon(input: $input)
}
Variables
{
"input": {
"brandID": "object",
"specs": [
{
"ID": "object",
"code": "string",
"title": "string",
"isActive": "boolean",
"salesChannel": "string",
"discountValue": {
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number",
"maximumDiscountValue": {
"code": "string",
"value": "number"
},
"discountType": "string",
"discountField": "string"
},
"allowedShippingMethods": [
"string"
],
"applicableStartTimestamp": "number",
"applicableEndTimestamp": "number",
"maximumUsageCount": "number",
"isMemberOnly": "boolean",
"allowedMemberLevels": [
"string"
],
"minimumPurchase": {
"code": "string",
"value": "number"
}
}
]
}
}
mutation upsertShippingCoupon($input: UpsertShippingCouponsInput!){
upsertShippingCoupon(input: $input)
}
{
"input": {
"brandID": "object",
"specs": [
{
"ID": "object",
"code": "string",
"title": "string",
"isActive": "boolean",
"salesChannel": "string",
"discountValue": {
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number",
"maximumDiscountValue": {
"code": "string",
"value": "number"
},
"discountType": "string",
"discountField": "string"
},
"allowedShippingMethods": [
"string"
],
"applicableStartTimestamp": "number",
"applicableEndTimestamp": "number",
"maximumUsageCount": "number",
"isMemberOnly": "boolean",
"allowedMemberLevels": [
"string"
],
"minimumPurchase": {
"code": "string",
"value": "number"
}
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertShippingCoupon": [
null
]
}
}
Upsert Birthday Coupon
Base method to upsert birthday coupon
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertBirthdayCoupon($input: UpsertBirthdayCouponsInput!){
upsertBirthdayCoupon(input: $input)
}
Variables
{
"input": {
"brandID": "object",
"specs": [
{
"ID": "object",
"code": "string",
"title": "string",
"isActive": "boolean",
"salesChannel": "string",
"discountValue": {
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number",
"maximumDiscountValue": {
"code": "string",
"value": "number"
},
"discountType": "string",
"discountField": "string"
},
"validityPeriod": "number",
"minimumPurchase": {
"code": "string",
"value": "number"
}
}
]
}
}
mutation upsertBirthdayCoupon($input: UpsertBirthdayCouponsInput!){
upsertBirthdayCoupon(input: $input)
}
{
"input": {
"brandID": "object",
"specs": [
{
"ID": "object",
"code": "string",
"title": "string",
"isActive": "boolean",
"salesChannel": "string",
"discountValue": {
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number",
"maximumDiscountValue": {
"code": "string",
"value": "number"
},
"discountType": "string",
"discountField": "string"
},
"validityPeriod": "number",
"minimumPurchase": {
"code": "string",
"value": "number"
}
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertBirthdayCoupon": [
null
]
}
}
Upsert New Member Coupons
Base method to upsert new member coupons
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertNewMemberCoupon($input: UpsertNewMemberCouponsInput!){
upsertNewMemberCoupon(input: $input)
}
Variables
{
"input": {
"brandID": "object",
"specs": [
{
"ID": "object",
"code": "string",
"title": "string",
"isActive": "boolean",
"salesChannel": "string",
"discountValue": {
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number",
"maximumDiscountValue": {
"code": "string",
"value": "number"
},
"discountType": "string",
"discountField": "string"
},
"validityPeriod": "number",
"minimumPurchase": {
"code": "string",
"value": "number"
}
}
]
}
}
mutation upsertNewMemberCoupon($input: UpsertNewMemberCouponsInput!){
upsertNewMemberCoupon(input: $input)
}
{
"input": {
"brandID": "object",
"specs": [
{
"ID": "object",
"code": "string",
"title": "string",
"isActive": "boolean",
"salesChannel": "string",
"discountValue": {
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number",
"maximumDiscountValue": {
"code": "string",
"value": "number"
},
"discountType": "string",
"discountField": "string"
},
"validityPeriod": "number",
"minimumPurchase": {
"code": "string",
"value": "number"
}
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertNewMemberCoupon": [
null
]
}
}
Delete Coupons
Base Method to delete coupons
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation deleteCoupons($input: DeleteCouponsInput!){
deleteCoupons(input: $input)
}
Variables
{
"input": {
"IDs": [
"object"
]
}
}
mutation deleteCoupons($input: DeleteCouponsInput!){
deleteCoupons(input: $input)
}
{
"input": {
"IDs": [
"object"
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteCoupons": "boolean"
}
}
Set Coupons As Active
Base method to set coupons as active
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setCouponsAsActive($input: SetCouponsAsActiveInput!){
setCouponsAsActive(input: $input)
}
Variables
{
"input": {
"IDs": [
"object"
]
}
}
mutation setCouponsAsActive($input: SetCouponsAsActiveInput!){
setCouponsAsActive(input: $input)
}
{
"input": {
"IDs": [
"object"
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setCouponsAsActive": "boolean"
}
}
Set Coupons As Inactive
Base method to set coupons as Inactive
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setCouponsAsInactive($input: SetCouponsAsInactiveInput!){
setCouponsAsInactive(input: $input)
}
Variables
{
"input": {
"IDs": [
"object"
]
}
}
mutation setCouponsAsInactive($input: SetCouponsAsInactiveInput!){
setCouponsAsInactive(input: $input)
}
{
"input": {
"IDs": [
"object"
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setCouponsAsInactive": "boolean"
}
}
Import Excel
This endpoint used to import excel file
Import Excel
Base method to import excel file
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation importExcel($input: ImportExcelInput!){
importExcel(input: $input){
ID
}
}
Variables
{
"input": {
"brandID": "string",
"fileName": "string",
"ignoreErrorRecord": "boolean",
"moduleName": "string",
"sendToEmail": "string"
}
}
mutation importExcel($input: ImportExcelInput!){
importExcel(input: $input){
ID
}
}
{
"input": {
"brandID": "string",
"fileName": "string",
"ignoreErrorRecord": "boolean",
"moduleName": "string",
"sendToEmail": "string"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"importExcel": {
"ID": "string"
}
}
}
Upload Document
This endpoint used to upload Document
Upload Document
This endpoint used to upload document
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation uploadDocument($input: UploadDocumentInput!){
uploadDocument(input: $input){
documentId
documentUrl
documentToken
}
}
Variables
{
"input": {
"brandID": "object",
"signerID": "string",
"documentName": "string",
"documentUrl": "string"
}
}
mutation uploadDocument($input: UploadDocumentInput!){
uploadDocument(input: $input){
documentId
documentUrl
documentToken
}
}
{
"input": {
"brandID": "object",
"signerID": "string",
"documentName": "string",
"documentUrl": "string"
}
}
200 OK
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"uploadDocument": {
"documentId": "string",
"documentUrl": "string",
"documentToken": "string"
}
}
}
Manage Navigations
This endpoint used to manage navigation
Manage Membership
This endpoint used to manage membership
Set Membership Model
Base method to set membership model
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setMembershipModel($input: SetMembershipModelInput!){
setMembershipModel(input: $input)
}
Variables
{
"input": {
"specs": [
{
"ID": "string",
"type": "string",
"brandID": "string",
"pointProvider": "string",
"membershipLevel": "string",
"percentageOfPointFromTotalPurchase": "number",
"discount": "number",
"isActive": "boolean",
"moneyPerPoint": "number",
"pointPerMoney": "number",
"maximumPointsToExchangePerTransaction": "number",
"minimumPointsToExchangePerTransaction": "number",
"minimumMoneyToSpendPerTransaction": "number",
"maximumMoneyToConvertPerTransaction": "number",
"minimumOrder": "number"
}
]
}
}
mutation setMembershipModel($input: SetMembershipModelInput!){
setMembershipModel(input: $input)
}
{
"input": {
"specs": [
{
"ID": "string",
"type": "string",
"brandID": "string",
"pointProvider": "string",
"membershipLevel": "string",
"percentageOfPointFromTotalPurchase": "number",
"discount": "number",
"isActive": "boolean",
"moneyPerPoint": "number",
"pointPerMoney": "number",
"maximumPointsToExchangePerTransaction": "number",
"minimumPointsToExchangePerTransaction": "number",
"minimumMoneyToSpendPerTransaction": "number",
"maximumMoneyToConvertPerTransaction": "number",
"minimumOrder": "number"
}
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setMembershipModel": "boolean"
}
}
Set Membership Point
Base method to set membership point
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setMembershipPoint($input: SetMembershipPointInput!){
setMembershipPoint(input: $input)
}
Variables
{
"input": {
"specs": [
{
"brandID": "object",
"memberID": "object",
"value": "number",
"pointProvider": "string",
"info": "string"
}
]
}
}
mutation setMembershipPoint($input: SetMembershipPointInput!){
setMembershipPoint(input: $input)
}
{
"input": {
"specs": [
{
"brandID": "object",
"memberID": "object",
"value": "number",
"pointProvider": "string",
"info": "string"
}
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setMembershipPoint": "boolean"
}
}
Add Membership Point
Base method to add membership point
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation addMembershipPoint($input: AddMembershipPointInput!){
addMembershipPoint(input: $input)
}
Variables
{
"input": {
"specs": [
{
"brandID": "object",
"memberID": "object",
"value": "number",
"pointProvider": "string",
"info": "string"
}
]
}
}
mutation addMembershipPoint($input: AddMembershipPointInput!){
addMembershipPoint(input: $input)
}
{
"input": {
"specs": [
{
"brandID": "object",
"memberID": "object",
"value": "number",
"pointProvider": "string",
"info": "string"
}
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"addMembershipPoint": "boolean"
}
}
Manage Marketplaces
This endpoint used to manage marketplaces on your store
Integrate Marketplace
Base method to integrate with marketplaces
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation integrateMarketplace($input: IntegrateMarketplaceInput!){
integrateMarketplace(input: $input)
}
Variables
{
"input": {
"brandID": "object",
"code": "object",
"payload": "string"
}
}
mutation integrateMarketplace($input: IntegrateMarketplaceInput!){
integrateMarketplace(input: $input)
}
{
"input": {
"brandID": "object",
"code": "object",
"payload": "string"
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"integrateMarketplace": "boolean"
}
}
Reintegrate Marketplace
Base method to reintegrate with marketplace
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation reintegrateMarketplace($input: ReintegrateMarketplaceInput!){
reintegrateMarketplace(input: $input)
}
Variables
{
"input": {
"brandID": "object",
"code": "object"
}
}
mutation reintegrateMarketplace($input: ReintegrateMarketplaceInput!){
reintegrateMarketplace(input: $input)
}
{
"input": {
"brandID": "object",
"code": "object"
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"reintegrateMarketplace": "boolean"
}
}
Disconnect Marketplace
Base method to disconnect marketplace
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation disconnectMarketplace($input: DisconnectMarketplaceInput!){
disconnectMarketplace(input: $input)
}
Variables
{
"input": {
"brandID": "object",
"code": "object"
}
}
mutation disconnectMarketplace($input: DisconnectMarketplaceInput!){
disconnectMarketplace(input: $input)
}
{
"input": {
"brandID": "object",
"code": "object"
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"disconnectMarketplace": "boolean"
}
}
Request Marketplace Integration
Base method to request integration
(no description)
Example
Request Content-Types:
application/json
Query
mutation requestMarketplaceIntegration($input: RequestMarketplaceIntegrationInput!){
requestMarketplaceIntegration(input: $input)
}
Variables
{
"input": {
"tenantID": "object",
"brandID": "object",
"channel": "string",
"credentials": "string"
}
}
mutation requestMarketplaceIntegration($input: RequestMarketplaceIntegrationInput!){
requestMarketplaceIntegration(input: $input)
}
{
"input": {
"tenantID": "object",
"brandID": "object",
"channel": "string",
"credentials": "string"
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"requestMarketplaceIntegration": "boolean"
}
}
Manage Testimonials
This endpoint used to manage testimonials
Upsert Testimonials
Base method to upsert testimonials
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertTestimonials($input: UpsertTestimonialsInput!){
upsertTestimonials(input: $input){
ID
brandID
email
author
company
website
memberID
productID
title
content
imageURLs
rating
createdAt
updatedAt
published
isFeatured
}
}
Variables
{
"input": {
"brandID": "string",
"specs": [
{
"ID": "string",
"email": "string",
"author": "string",
"company": "string",
"website": "string",
"memberID": "string",
"productID": "string",
"title": "string",
"content": "string",
"imageURLs": [
"string"
],
"rating": "number",
"createdAt": "number",
"updatedAt": "number",
"published": "boolean",
"isFeatured": "boolean"
}
]
}
}
mutation upsertTestimonials($input: UpsertTestimonialsInput!){
upsertTestimonials(input: $input){
ID
brandID
email
author
company
website
memberID
productID
title
content
imageURLs
rating
createdAt
updatedAt
published
isFeatured
}
}
{
"input": {
"brandID": "string",
"specs": [
{
"ID": "string",
"email": "string",
"author": "string",
"company": "string",
"website": "string",
"memberID": "string",
"productID": "string",
"title": "string",
"content": "string",
"imageURLs": [
"string"
],
"rating": "number",
"createdAt": "number",
"updatedAt": "number",
"published": "boolean",
"isFeatured": "boolean"
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertTestimonials": [
{
"ID": "string",
"brandID": "string",
"email": "string",
"author": "string",
"company": "string",
"website": "string",
"memberID": "string",
"productID": "string",
"title": "string",
"content": "string",
"imageURLs": [
"string"
],
"rating": "integer",
"createdAt": "integer",
"updatedAt": "integer",
"published": "boolean",
"isFeatured": "boolean"
}
]
}
}
Create New Testimonials
Base method to create new testimonials
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation createTestimonials($input: CreateTestimonialsInput!){
createTestimonials(input: $input){
ID
brandID
email
author
company
website
memberID
productID
title
content
imageURLs
rating
createdAt
updatedAt
published
isFeatured
}
}
Variables
{
"input": {
"brandID": "string",
"specs": [
{
"email": "string",
"author": "string",
"company": "string",
"website": "string",
"memberID": "string",
"productID": "string",
"title": "string",
"content": "string",
"imageURLs": [
"string"
],
"rating": "number",
"createdAt": "number",
"updatedAt": "number",
"published": "boolean",
"isFeatured": "boolean"
}
]
}
}
mutation createTestimonials($input: CreateTestimonialsInput!){
createTestimonials(input: $input){
ID
brandID
email
author
company
website
memberID
productID
title
content
imageURLs
rating
createdAt
updatedAt
published
isFeatured
}
}
{
"input": {
"brandID": "string",
"specs": [
{
"email": "string",
"author": "string",
"company": "string",
"website": "string",
"memberID": "string",
"productID": "string",
"title": "string",
"content": "string",
"imageURLs": [
"string"
],
"rating": "number",
"createdAt": "number",
"updatedAt": "number",
"published": "boolean",
"isFeatured": "boolean"
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createTestimonials": [
{
"ID": "string",
"brandID": "string",
"email": "string",
"author": "string",
"company": "string",
"website": "string",
"memberID": "string",
"productID": "string",
"title": "string",
"content": "string",
"imageURLs": [
"string"
],
"rating": "integer",
"createdAt": "integer",
"updatedAt": "integer",
"published": "boolean",
"isFeatured": "boolean"
}
]
}
}
Publish Testimonials
Base method to publish testimonials
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation publishTestimonials($input: PublishTestimonialsInput!){
publishTestimonials(input: $input)
}
Variables
{
"input": {
"IDs": [
"object"
]
}
}
mutation publishTestimonials($input: PublishTestimonialsInput!){
publishTestimonials(input: $input)
}
{
"input": {
"IDs": [
"object"
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"publishTestimonials": "boolean"
}
}
Unpublish Testimonials
Base method to unpublish testimonials
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation unpublishTestimonials($input: UnpublishTestimonialsInput!){
unpublishTestimonials(input: $input)
}
Variables
{
"input": {
"IDs": [
"object"
]
}
}
mutation unpublishTestimonials($input: UnpublishTestimonialsInput!){
unpublishTestimonials(input: $input)
}
{
"input": {
"IDs": [
"object"
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"unpublishTestimonials": "boolean"
}
}
Delete Testimonials
Base method to delete testimonials
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation deleteTestimonials($input: DeleteTestimonialsInput!){
deleteTestimonials(input: $input)
}
Variables
{
"input": {
"IDs": [
"object"
]
}
}
mutation deleteTestimonials($input: DeleteTestimonialsInput!){
deleteTestimonials(input: $input)
}
{
"input": {
"IDs": [
"object"
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteTestimonials": "boolean"
}
}
Reorder Testimonials
Base method to reorder testimonials
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation unpublishTestimonials($input: UnpublishTestimonialsInput!){
unpublishTestimonials(input: $input)
}
Variables
{
"input": {
"IDs": [
"object"
]
}
}
mutation unpublishTestimonials($input: UnpublishTestimonialsInput!){
unpublishTestimonials(input: $input)
}
{
"input": {
"IDs": [
"object"
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"unpublishTestimonials": "boolean"
}
}
Manage Banners
This endpoint used to manage banners
Create Enquiry
This endpoint used to create enquiry
Create enquiry
Base method to create enquiry
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation createEnquiry($input: CreateEnquiryInput!){
createEnquiry(input: $input){
ID
brandID
email
message
name
phone
referer
subject
createdAt
updatedAt
}
}
Variables
{
"input": {
"brandID": "string",
"specs": [
{
"email": "string",
"message": "string",
"name": "string",
"phone": "string",
"referer": "string",
"subject": "string",
"customFields": [
{
"key": "string",
"value": "string"
}
],
"createdAt": "number",
"updatedAt": "number"
}
]
}
}
mutation createEnquiry($input: CreateEnquiryInput!){
createEnquiry(input: $input){
ID
brandID
email
message
name
phone
referer
subject
createdAt
updatedAt
}
}
{
"input": {
"brandID": "string",
"specs": [
{
"email": "string",
"message": "string",
"name": "string",
"phone": "string",
"referer": "string",
"subject": "string",
"customFields": [
{
"key": "string",
"value": "string"
}
],
"createdAt": "number",
"updatedAt": "number"
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createEnquiry": [
{
"ID": "string",
"brandID": "string",
"email": "string",
"message": "string",
"name": "string",
"phone": "string",
"referer": "string",
"subject": "string",
"createdAt": "integer",
"updatedAt": "integer"
}
]
}
}
Manage Newsletters
This endpoint used to manage NewsLetters
Create Newletters
Base method to create new newsletter
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation createNewsletters($input: CreateNewslettersInput!){
createNewsletters(input: $input)
}
Variables
{
"input": {
"brandID": "string",
"specs": [
{
"email": "string"
}
]
}
}
mutation createNewsletters($input: CreateNewslettersInput!){
createNewsletters(input: $input)
}
{
"input": {
"brandID": "string",
"specs": [
{
"email": "string"
}
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createNewsletters": "boolean"
}
}
Delete Newletters
Base method to delete newsletter
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation deleteNewsletters($input: DeleteNewslettersInput!){
deleteNewsletters(input: $input)
}
Variables
{
"input": {
"IDs": [
"object"
]
}
}
mutation deleteNewsletters($input: DeleteNewslettersInput!){
deleteNewsletters(input: $input)
}
{
"input": {
"IDs": [
"object"
]
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteNewsletters": "boolean"
}
}
Export Newletters
Base method to export list of newsletter
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation exportNewsletters($input: ExportNewslettersInput!){
exportNewsletters(input: $input)
}
Variables
{
"input": {
"brandID": "string",
"columnNames": [
"string"
],
"IDs": [
"object"
],
"sendToEmail": "string"
}
}
mutation exportNewsletters($input: ExportNewslettersInput!){
exportNewsletters(input: $input)
}
{
"input": {
"brandID": "string",
"columnNames": [
"string"
],
"IDs": [
"object"
],
"sendToEmail": "string"
}
}
200 OK
Successful operation
type
string
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"exportNewsletters": "string"
}
}
Upsert Newletters Settings
Base method to upsert detail for newsletter setting
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertNewsletterSettings($input: UpsertNewsletterSettingsInput!){
upsertNewsletterSettings(input: $input)
}
Variables
{
"input": {
"brandID": "string",
"credential": {
"apiKey": "string",
"listId": "string"
},
"popup": {
"content": "string",
"popupOnFirstVisit": "boolean"
}
}
}
mutation upsertNewsletterSettings($input: UpsertNewsletterSettingsInput!){
upsertNewsletterSettings(input: $input)
}
{
"input": {
"brandID": "string",
"credential": {
"apiKey": "string",
"listId": "string"
},
"popup": {
"content": "string",
"popupOnFirstVisit": "boolean"
}
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertNewsletterSettings": "boolean"
}
}
Upsert Socmed Setting
This endpoint used to upsert socmed setting
Upsert Socmed Setting
Base method to upsert socmed setting
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertSocmedSetting($input: UpsertSocmedSettingInput!){
upsertSocmedSetting(input: $input){
status
message
}
}
Variables
{
"input": {
"brandID": "string",
"instagramToken": "string",
"socmedLink": {
"twitter": "string",
"facebook": "string",
"instagram": "string",
"youtube": "string",
"tiktok": "string"
}
}
}
mutation upsertSocmedSetting($input: UpsertSocmedSettingInput!){
upsertSocmedSetting(input: $input){
status
message
}
}
{
"input": {
"brandID": "string",
"instagramToken": "string",
"socmedLink": {
"twitter": "string",
"facebook": "string",
"instagram": "string",
"youtube": "string",
"tiktok": "string"
}
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertSocmedSetting": {
"status": "boolean",
"message": "string"
}
}
}
Manage Status of Orders
This endpoint used to manage status of orders
Accept Orders
Base method to accept orders status
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation acceptOrders($input: AcceptOrderReq!){
acceptOrders(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
Variables
{
"input": {
"orderIDs": [
"string"
],
"notes": "string"
}
}
mutation acceptOrders($input: AcceptOrderReq!){
acceptOrders(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
{
"input": {
"orderIDs": [
"string"
],
"notes": "string"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"acceptOrders": [
{
"ID": "string",
"brandID": "string",
"channelID": "string",
"invoiceID": "string",
"createdAt": "integer",
"updatedAt": "integer",
"paymentStatus": "string",
"memberID": "string",
"buyerNote": "string",
"paymentLinks": [
"string"
]
}
]
}
}
Cancel Orders
Base method to cancel orders status
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation cancelOrders($input: CancelOrderReq!){
cancelOrders(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
Variables
{
"input": {
"specs": [
{
"orderId": "string",
"notes": "string"
}
]
}
}
mutation cancelOrders($input: CancelOrderReq!){
cancelOrders(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
{
"input": {
"specs": [
{
"orderId": "string",
"notes": "string"
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"cancelOrders": [
{
"ID": "string",
"brandID": "string",
"channelID": "string",
"invoiceID": "string",
"createdAt": "integer",
"updatedAt": "integer",
"paymentStatus": "string",
"memberID": "string",
"buyerNote": "string",
"paymentLinks": [
"string"
]
}
]
}
}
Complete Orders
Base method to complete orders status
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation completeOrders($input: CompleteOrderReq!){
completeOrders(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
Variables
{
"input": {
"orderIDs": [
"string"
],
"notes": "string"
}
}
mutation completeOrders($input: CompleteOrderReq!){
completeOrders(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
{
"input": {
"orderIDs": [
"string"
],
"notes": "string"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"completeOrders": [
{
"ID": "string",
"brandID": "string",
"channelID": "string",
"invoiceID": "string",
"createdAt": "integer",
"updatedAt": "integer",
"paymentStatus": "string",
"memberID": "string",
"buyerNote": "string",
"paymentLinks": [
"string"
]
}
]
}
}
Set Status As Ready To Ship
Base method to set status as ready to ship
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setStatusAsReadyToShip($input: SetStatusAsReadyToShipReq!){
setStatusAsReadyToShip(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
Variables
{
"input": {
"specs": [
{
"orderId": "string",
"awbNumber": "string",
"isAutoAwb": "boolean"
}
]
}
}
mutation setStatusAsReadyToShip($input: SetStatusAsReadyToShipReq!){
setStatusAsReadyToShip(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
{
"input": {
"specs": [
{
"orderId": "string",
"awbNumber": "string",
"isAutoAwb": "boolean"
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setStatusAsReadyToShip": [
{
"ID": "string",
"brandID": "string",
"channelID": "string",
"invoiceID": "string",
"createdAt": "integer",
"updatedAt": "integer",
"paymentStatus": "string",
"memberID": "string",
"buyerNote": "string",
"paymentLinks": [
"string"
]
}
]
}
}
Ship Orders
Base method to ship Orders
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation shipOrders($input: ShipOrderReq!){
shipOrders(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
Variables
{
"input": {
"orderIDs": [
"string"
],
"notes": "string"
}
}
mutation shipOrders($input: ShipOrderReq!){
shipOrders(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
{
"input": {
"orderIDs": [
"string"
],
"notes": "string"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"shipOrders": [
{
"ID": "string",
"brandID": "string",
"channelID": "string",
"invoiceID": "string",
"createdAt": "integer",
"updatedAt": "integer",
"paymentStatus": "string",
"memberID": "string",
"buyerNote": "string",
"paymentLinks": [
"string"
]
}
]
}
}
Set Order Delivery
Base method to upsert order's delivery address
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setOrderDelivery($input: SetOrderDeliveryInput!){
setOrderDelivery(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
Variables
{
"input": {
"orderID": "string",
"deliveryAddress": {
"districtCode": "string",
"email": "string",
"name": "string",
"phone": "string",
"postalCode": "string",
"street": "string",
"longLat": "string"
},
"shipping": {
"provider": "string",
"service": "string"
}
}
}
mutation setOrderDelivery($input: SetOrderDeliveryInput!){
setOrderDelivery(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
{
"input": {
"orderID": "string",
"deliveryAddress": {
"districtCode": "string",
"email": "string",
"name": "string",
"phone": "string",
"postalCode": "string",
"street": "string",
"longLat": "string"
},
"shipping": {
"provider": "string",
"service": "string"
}
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setOrderDelivery": {
"ID": "string",
"brandID": "string",
"channelID": "string",
"invoiceID": "string",
"createdAt": "integer",
"updatedAt": "integer",
"paymentStatus": "string",
"memberID": "string",
"buyerNote": "string",
"paymentLinks": [
"string"
]
}
}
}
Set Order Line Items
Base method to upsert order's line items
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setOrderLineItems($input: SetOrderLineItemsInput!){
setOrderLineItems(input: $input){
ID
paymentLink
}
}
Variables
{
"input": {
"orderID": "string",
"lineItems": [
{
"SKU": "string",
"quantity": "number"
}
]
}
}
mutation setOrderLineItems($input: SetOrderLineItemsInput!){
setOrderLineItems(input: $input){
ID
paymentLink
}
}
{
"input": {
"orderID": "string",
"lineItems": [
{
"SKU": "string",
"quantity": "number"
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setOrderLineItems": {
"ID": "string",
"paymentLink": "string"
}
}
}
Set Order Shipping
Base method to upsert order's shipping method
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setOrderShipping($input: SetOrderShippingInput!){
setOrderShipping(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
Variables
{
"input": {
"orderID": "string",
"shipping": {
"AWBNumber": "string",
"provider": "string",
"service": "string"
}
}
}
mutation setOrderShipping($input: SetOrderShippingInput!){
setOrderShipping(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
{
"input": {
"orderID": "string",
"shipping": {
"AWBNumber": "string",
"provider": "string",
"service": "string"
}
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setOrderShipping": [
{
"ID": "string",
"brandID": "string",
"channelID": "string",
"invoiceID": "string",
"createdAt": "integer",
"updatedAt": "integer",
"paymentStatus": "string",
"memberID": "string",
"buyerNote": "string",
"paymentLinks": [
"string"
]
}
]
}
}
Set Oder Payment
Base method to be deprecated upsert order's payment method
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setOrderPayment($input: SetOrderPaymentInput!){
setOrderPayment(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
Variables
{
"input": {
"orderID": "string",
"payment": {
"provider": "string",
"service": "string",
"fee": {
"code": "string",
"value": "number"
},
"uniqueCode": "number"
}
}
}
mutation setOrderPayment($input: SetOrderPaymentInput!){
setOrderPayment(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
{
"input": {
"orderID": "string",
"payment": {
"provider": "string",
"service": "string",
"fee": {
"code": "string",
"value": "number"
},
"uniqueCode": "number"
}
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setOrderPayment": {
"ID": "string",
"brandID": "string",
"channelID": "string",
"invoiceID": "string",
"createdAt": "integer",
"updatedAt": "integer",
"paymentStatus": "string",
"memberID": "string",
"buyerNote": "string",
"paymentLinks": [
"string"
]
}
}
}
Set Orchestrator Payment
Base method to set Order Orchestrator
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation setOrchestratorPayment($input: setOrchestratorPaymentInput!){
setOrchestratorPayment(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
Variables
{
"input": {
"orderID": "string",
"payment": {
"provider": "string",
"service": "string"
}
}
}
mutation setOrchestratorPayment($input: setOrchestratorPaymentInput!){
setOrchestratorPayment(input: $input){
ID
brandID
channelID
invoiceID
createdAt
updatedAt
status
paymentStatus
memberID
buyerNote
paymentLinks
}
}
{
"input": {
"orderID": "string",
"payment": {
"provider": "string",
"service": "string"
}
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setOrchestratorPayment": {
"ID": "string",
"brandID": "string",
"channelID": "string",
"invoiceID": "string",
"createdAt": "integer",
"updatedAt": "integer",
"paymentStatus": "string",
"memberID": "string",
"buyerNote": "string",
"paymentLinks": [
"string"
]
}
}
}
Manage Analytics
This endpoint used to manage analytics
Upsert Analytics
Base method to upsert analytics
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertAnalytics($input: UpsertAnalyticsInput!){
upsertAnalytics(input: $input){
status
message
}
}
Variables
{
"input": {
"brandID": "object"
}
}
mutation upsertAnalytics($input: UpsertAnalyticsInput!){
upsertAnalytics(input: $input){
status
message
}
}
{
"input": {
"brandID": "object"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertAnalytics": {
"status": "boolean",
"message": "string"
}
}
}
Upsert Analytic Setting
Base method to upsert analytics setting
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertAnalyticsSetting($input: UpsertAnalyticsSettingInput!){
upsertAnalyticsSetting(input: $input){
status
message
}
}
Variables
{
"input": {
"brandId": "object",
"facebookSetting": {
"pixelId": "string",
"catalogId": "string",
"accessToken": "string"
},
"googleSetting": {
"universalAnalytics": {
"trackingId": "string"
}
}
}
}
mutation upsertAnalyticsSetting($input: UpsertAnalyticsSettingInput!){
upsertAnalyticsSetting(input: $input){
status
message
}
}
{
"input": {
"brandId": "object",
"facebookSetting": {
"pixelId": "string",
"catalogId": "string",
"accessToken": "string"
},
"googleSetting": {
"universalAnalytics": {
"trackingId": "string"
}
}
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertAnalyticsSetting": {
"status": "boolean",
"message": "string"
}
}
}
Manage Login By User Id Token
This endpoint used to manage login by id token
Admin Login By Id Token
Base method to admin login by user Id Token
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation memberLoginByIdToken($input: MemberLoginByIdTokenInput!){
memberLoginByIdToken(input: $input){
accessToken
email
firstName
lastName
}
}
Variables
{
"input": {
"brandID": "object",
"idToken": "string",
"provider": "string"
}
}
mutation memberLoginByIdToken($input: MemberLoginByIdTokenInput!){
memberLoginByIdToken(input: $input){
accessToken
email
firstName
lastName
}
}
{
"input": {
"brandID": "object",
"idToken": "string",
"provider": "string"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"memberLoginByIdToken": {
"accessToken": "string",
"email": "string",
"firstName": "string",
"lastName": "string"
}
}
}
Member Login By Id Token
Base method to login by user Id Token
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation memberLoginByIdToken($input: MemberLoginByIdTokenInput!){
memberLoginByIdToken(input: $input){
accessToken
email
firstName
lastName
}
}
Variables
{
"input": {
"brandID": "object",
"idToken": "string",
"provider": "string"
}
}
mutation memberLoginByIdToken($input: MemberLoginByIdTokenInput!){
memberLoginByIdToken(input: $input){
accessToken
email
firstName
lastName
}
}
{
"input": {
"brandID": "object",
"idToken": "string",
"provider": "string"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"memberLoginByIdToken": {
"accessToken": "string",
"email": "string",
"firstName": "string",
"lastName": "string"
}
}
}
Manage Google Account
This endpoint used to manage Google Account
Link Google Merchant Account
Base method to link google merchant account
(no description)
Example
Request Content-Types:
application/json
Query
mutation linkGoogleMerchantAccount($input: LinkGoogleMerchantAccountInput!){
linkGoogleMerchantAccount(input: $input)
}
Variables
{
"input": {
"brandID": "object",
"websiteURL": "string"
}
}
mutation linkGoogleMerchantAccount($input: LinkGoogleMerchantAccountInput!){
linkGoogleMerchantAccount(input: $input)
}
{
"input": {
"brandID": "object",
"websiteURL": "string"
}
}
200 OK
Successful operation
type
integer
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"linkGoogleMerchantAccount": "integer"
}
}
Unlink Google Merchant Account
Base method to unlink google merchant account
(no description)
Example
Request Content-Types:
application/json
Query
mutation unlinkGoogleMerchantAccount($input: UnlinkGoogleMerchantAccountInput!){
unlinkGoogleMerchantAccount(input: $input)
}
Variables
{
"input": {
"brandID": "object"
}
}
mutation unlinkGoogleMerchantAccount($input: UnlinkGoogleMerchantAccountInput!){
unlinkGoogleMerchantAccount(input: $input)
}
{
"input": {
"brandID": "object"
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"unlinkGoogleMerchantAccount": "boolean"
}
}
Link Google Ads Account
Base method to link google ads account
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation linkGoogleAdsAccount($input: LinkGoogleAdsAccountInput!){
linkGoogleAdsAccount(input: $input)
}
Variables
{
"input": {
"brandID": "object"
}
}
mutation linkGoogleAdsAccount($input: LinkGoogleAdsAccountInput!){
linkGoogleAdsAccount(input: $input)
}
{
"input": {
"brandID": "object"
}
}
200 OK
Successful operation
type
string
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"linkGoogleAdsAccount": "string"
}
}
Unlink Google Ads Account
Base method to unlink google ads account
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation unlinkGoogleAdsAccount($input: UnlinkGoogleAdsAccountInput!){
unlinkGoogleAdsAccount(input: $input)
}
Variables
{
"input": {
"brandID": "object"
}
}
mutation unlinkGoogleAdsAccount($input: UnlinkGoogleAdsAccountInput!){
unlinkGoogleAdsAccount(input: $input)
}
{
"input": {
"brandID": "object"
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"unlinkGoogleAdsAccount": "boolean"
}
}
Claim Google Merchant Website
Base method to claim google merchant website
(no description)
Example
Request Content-Types:
application/json
Query
mutation claimGoogleMerchantWebsite($input: ClaimGoogleMerchantWebsiteInput!){
claimGoogleMerchantWebsite(input: $input)
}
Variables
{
"input": {
"brandID": "object"
}
}
mutation claimGoogleMerchantWebsite($input: ClaimGoogleMerchantWebsiteInput!){
claimGoogleMerchantWebsite(input: $input)
}
{
"input": {
"brandID": "object"
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"claimGoogleMerchantWebsite": "boolean"
}
}
Upsert Google Ads Campaign
Base method to create google ads campaign
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertGoogleAdsCampaign($input: UpsertGoogleAdsCampaignInput!){
upsertGoogleAdsCampaign(input: $input)
}
Variables
{
"input": {
"brandID": "string",
"budget": "number"
}
}
mutation upsertGoogleAdsCampaign($input: UpsertGoogleAdsCampaignInput!){
upsertGoogleAdsCampaign(input: $input)
}
{
"input": {
"brandID": "string",
"budget": "number"
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertGoogleAdsCampaign": "boolean"
}
}
Remove Google Account
Base method to remove google account
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation removeGoogleAccount($input: RemoveGoogleAccountInput!){
removeGoogleAccount(input: $input)
}
Variables
{
"input": {
"brandID": "object"
}
}
mutation removeGoogleAccount($input: RemoveGoogleAccountInput!){
removeGoogleAccount(input: $input)
}
{
"input": {
"brandID": "object"
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"removeGoogleAccount": "boolean"
}
}
Add Stock Reminder Customer
This endpoint used to add stock reminder customer
Add Stock Reminder Customer
Base method to add stock reminder customer
(no description)
Example
Request Content-Types:
application/json
Query
mutation addStockReminderCustomer($input: AddStockReminderCustomerInput!){
addStockReminderCustomer(input: $input)
}
Variables
{
"input": {
"productID": "string",
"sku": "string",
"contact": "string",
"type": "string"
}
}
mutation addStockReminderCustomer($input: AddStockReminderCustomerInput!){
addStockReminderCustomer(input: $input)
}
{
"input": {
"productID": "string",
"sku": "string",
"contact": "string",
"type": "string"
}
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"addStockReminderCustomer": "boolean"
}
}
Upsert Links Page
This endpoint used to upsert link page
Upsert Links Page
Base method to upsert links page
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertLinkspage($input: UpsertLinkspageInput!){
upsertLinkspage(input: $input){
status
message
}
}
Variables
{
"input": {
"brandId": "string",
"backgroundColor": "string",
"description": "string",
"hexTextColor": "string",
"logoImage": "string",
"name": "string",
"detailLinks": [
{
"hexBorderColor": "string",
"hexLabelColor": "string",
"iconImage": "string",
"id": "string",
"label": "string",
"ordering": "number",
"url": "string"
}
]
}
}
mutation upsertLinkspage($input: UpsertLinkspageInput!){
upsertLinkspage(input: $input){
status
message
}
}
{
"input": {
"brandId": "string",
"backgroundColor": "string",
"description": "string",
"hexTextColor": "string",
"logoImage": "string",
"name": "string",
"detailLinks": [
{
"hexBorderColor": "string",
"hexLabelColor": "string",
"iconImage": "string",
"id": "string",
"label": "string",
"ordering": "number",
"url": "string"
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertLinkspage": {
"status": "boolean",
"message": "string"
}
}
}
Manage Product Review
This endpoint used to manage product review
Upsert Prodyct Review
Base method to upsert product review for admin
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertProductReview($input: UpsertProductReviewInput!){
upsertProductReview(input: $input){
ID
brandID
orderID
orderCompletedAt
productID
rating
review
imageURLs
videoURLs
reviewerName
reviewerEmail
customerID
createdByAdmin
submittedAt
status
}
}
Variables
{
"input": {
"specs": [
{
"ID": "object",
"brandID": "object",
"productID": "object",
"imageURLs": [
"string"
]
}
]
}
}
mutation upsertProductReview($input: UpsertProductReviewInput!){
upsertProductReview(input: $input){
ID
brandID
orderID
orderCompletedAt
productID
rating
review
imageURLs
videoURLs
reviewerName
reviewerEmail
customerID
createdByAdmin
submittedAt
status
}
}
{
"input": {
"specs": [
{
"ID": "object",
"brandID": "object",
"productID": "object",
"imageURLs": [
"string"
]
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertProductReview": [
{
"ID": "string",
"brandID": "string",
"orderID": "string",
"orderCompletedAt": "integer",
"productID": "string",
"rating": "integer",
"review": "string",
"imageURLs": [
"string"
],
"videoURLs": [
"string"
],
"reviewerName": "string",
"reviewerEmail": "string",
"customerID": "string",
"createdByAdmin": "boolean",
"submittedAt": "integer"
}
]
}
}
Submit Product Review By Customer
Base method to submit product review for customer
(no description)
Example
Request Content-Types:
application/json
Query
mutation submitProductReviewByCustomer($input: SubmitProductReviewByCustomerInput!){
submitProductReviewByCustomer(input: $input){
ID
brandID
orderID
orderCompletedAt
productID
rating
review
imageURLs
videoURLs
reviewerName
reviewerEmail
customerID
createdByAdmin
submittedAt
status
}
}
Variables
{
"input": {
"specs": [
{
"ID": "object",
"brandID": "object",
"productID": "object",
"rating": "number",
"review": "string",
"imageURLs": [
"string"
],
"videoURLs": [
"string"
],
"reviewerName": "string",
"reviewerEmail": "string",
"orderID": "string"
}
]
}
}
mutation submitProductReviewByCustomer($input: SubmitProductReviewByCustomerInput!){
submitProductReviewByCustomer(input: $input){
ID
brandID
orderID
orderCompletedAt
productID
rating
review
imageURLs
videoURLs
reviewerName
reviewerEmail
customerID
createdByAdmin
submittedAt
status
}
}
{
"input": {
"specs": [
{
"ID": "object",
"brandID": "object",
"productID": "object",
"rating": "number",
"review": "string",
"imageURLs": [
"string"
],
"videoURLs": [
"string"
],
"reviewerName": "string",
"reviewerEmail": "string",
"orderID": "string"
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"submitProductReviewByCustomer": [
{
"ID": "string",
"brandID": "string",
"orderID": "string",
"orderCompletedAt": "integer",
"productID": "string",
"rating": "integer",
"review": "string",
"imageURLs": [
"string"
],
"videoURLs": [
"string"
],
"reviewerName": "string",
"reviewerEmail": "string",
"customerID": "string",
"createdByAdmin": "boolean",
"submittedAt": "integer"
}
]
}
}
Update Product Review Status
Base method to update product review status
(no description)
Example
Request Content-Types:
application/json
Query
mutation updateProductReviewStatus($input: UpdateProductReviewStatusInput!){
updateProductReviewStatus(input: $input){
failedUpdateIDs
}
}
Variables
{
"input": {
"specs": [
{
"ID": "object",
"brandID": "object",
"status": "string"
}
]
}
}
mutation updateProductReviewStatus($input: UpdateProductReviewStatusInput!){
updateProductReviewStatus(input: $input){
failedUpdateIDs
}
}
{
"input": {
"specs": [
{
"ID": "object",
"brandID": "object",
"status": "string"
}
]
}
}
200 OK
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"updateProductReviewStatus": {
"failedUpdateIDs": [
"string"
]
}
}
}
Set Escrow Activation Status
This endpoint used to set escrow status as active
Set Escrow Activation Status
Base method to activate status of escrow
(no description)
Example
Request Content-Types:
application/json
Query
mutation setEscrowActivationStatus($input: SetEscrowActivationStatusInput!){
setEscrowActivationStatus(input: $input){
brandID
activatedBy
activatedAt
isActive
}
}
Variables
{
"input": {
"brandID": "string",
"isActive": "boolean",
"activatedBy": "string"
}
}
mutation setEscrowActivationStatus($input: SetEscrowActivationStatusInput!){
setEscrowActivationStatus(input: $input){
brandID
activatedBy
activatedAt
isActive
}
}
{
"input": {
"brandID": "string",
"isActive": "boolean",
"activatedBy": "string"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"setEscrowActivationStatus": {
"brandID": "string",
"activatedBy": "string",
"activatedAt": "integer",
"isActive": "boolean"
}
}
}
Place Order
This endpoint used to update place order
Place Order
Base method to place order
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation placeOrder($input: PlaceOrderInput!){
placeOrder(input: $input){
ID
paymentLink
}
}
Variables
{
"input": {
"brandID": "object",
"buyerNote": "string",
"cartID": "object"
}
}
mutation placeOrder($input: PlaceOrderInput!){
placeOrder(input: $input){
ID
paymentLink
}
}
{
"input": {
"brandID": "object",
"buyerNote": "string",
"cartID": "object"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"placeOrder": {
"ID": "string",
"paymentLink": "string"
}
}
}
Update Business Hours
This endpoint used to update business hours
Update Business Hours
Base method to update business hours
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation updateBusinessHours($input: UpdateBusinessHoursInput!){
updateBusinessHours(input: $input){
day
shortName
longName
openAt
closeAt
isOpen
}
}
Variables
{
"input": {
"sellerID": "object",
"specs": [
{
"day": "number",
"openAt": "string",
"closeAt": "string",
"isOpen": "boolean"
}
]
}
}
mutation updateBusinessHours($input: UpdateBusinessHoursInput!){
updateBusinessHours(input: $input){
day
shortName
longName
openAt
closeAt
isOpen
}
}
{
"input": {
"sellerID": "object",
"specs": [
{
"day": "number",
"openAt": "string",
"closeAt": "string",
"isOpen": "boolean"
}
]
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"updateBusinessHours": [
{
"day": "integer",
"shortName": "string",
"longName": "string",
"openAt": "string",
"closeAt": "string",
"isOpen": "boolean"
}
]
}
}
Manage Decision
This endpoint used to manage decision
Manage Upload URL
This endpoint used to manage URL
Get Signed URL
Base method to get Signed URL
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation getSignedUrl($input: GetSignedUrlInput!){
getSignedUrl(input: $input){
url
}
}
Variables
{
"input": {
"uploadType": "string",
"pathName": "string",
"fileName": "string",
"contentType": "string",
"method": "string"
}
}
mutation getSignedUrl($input: GetSignedUrlInput!){
getSignedUrl(input: $input){
url
}
}
{
"input": {
"uploadType": "string",
"pathName": "string",
"fileName": "string",
"contentType": "string",
"method": "string"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"getSignedUrl": {
"url": "string"
}
}
}
Single Upload
Base method to single updload
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation singleUpload($input: SingleUploadInput!){
singleUpload(input: $input){
url
filename
mimetype
encoding
}
}
Variables
{
"input": {
"file": "object",
"bucket": "string",
"contentType": "string",
"uploadType": "string"
}
}
mutation singleUpload($input: SingleUploadInput!){
singleUpload(input: $input){
url
filename
mimetype
encoding
}
}
{
"input": {
"file": "object",
"bucket": "string",
"contentType": "string",
"uploadType": "string"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"singleUpload": {
"url": "string",
"filename": "string",
"mimetype": "string",
"encoding": "string"
}
}
}
Single Upload from URL
Base method to single upload from URL
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation singleUploadFromURL($input: SingleUploadFromURLInput!){
singleUploadFromURL(input: $input){
url
filename
mimetype
encoding
}
}
Variables
{
"input": {
"url": "string",
"bucket": "string",
"uploadType": "string"
}
}
mutation singleUploadFromURL($input: SingleUploadFromURLInput!){
singleUploadFromURL(input: $input){
url
filename
mimetype
encoding
}
}
{
"input": {
"url": "string",
"bucket": "string",
"uploadType": "string"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"singleUploadFromURL": {
"url": "string",
"filename": "string",
"mimetype": "string",
"encoding": "string"
}
}
}
Manage Bank Account
This endpoint used to manage Bank Account
Create Bank Account
Base method to create new bank acconut
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation createBankAccount($input: BankAccountInput){
createBankAccount(input: $input){
}
}
Variables
{
"input": {
"brandId": "string",
"bank": "string",
"accountNumber": "string",
"name": "string",
"expiry": "number"
}
}
mutation createBankAccount($input: BankAccountInput){
createBankAccount(input: $input){
}
}
{
"input": {
"brandId": "string",
"bank": "string",
"accountNumber": "string",
"name": "string",
"expiry": "number"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createBankAccount": {}
}
}
Upsert Bank Account
Base method to upsert bank account
ID:
string
(no description)
input:
(no description)
Example
Request Content-Types:
application/json
Query
mutation upsertBankAccount($ID: ID!, $input: BankAccountInput){
upsertBankAccount(ID: $ID, input: $input){
}
}
Variables
{
"ID": "string",
"input": {
"brandId": "string",
"bank": "string",
"accountNumber": "string",
"name": "string",
"expiry": "number"
}
}
mutation upsertBankAccount($ID: ID!, $input: BankAccountInput){
upsertBankAccount(ID: $ID, input: $input){
}
}
{
"ID": "string",
"input": {
"brandId": "string",
"bank": "string",
"accountNumber": "string",
"name": "string",
"expiry": "number"
}
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"upsertBankAccount": {}
}
}
Delete Bank Account
Base method to delete bank account
ID:
string
(no description)
Example
Request Content-Types:
application/json
Query
mutation deleteBankAccount($ID: ID!){
deleteBankAccount(ID: $ID)
}
Variables
{
"ID": "string"
}
mutation deleteBankAccount($ID: ID!){
deleteBankAccount(ID: $ID)
}
{
"ID": "string"
}
200 OK
Successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteBankAccount": "boolean"
}
}
Schema Definitions
AWBStatusInput: object
- specs:
-
Specifications for airway bill status input.
Example
{
"specs": [
{
"AWBNumber": "string",
"orderID": "string",
"isAutoAwb": "boolean"
}
]
}
AccessToken: object
- accountID:
- account:
- accessToken:
- tenantID:
- tenant:
- allowedActions:
- isAdmin:
Example
{
"accountID": "string",
"account": {
"accountID": "string",
"ID": "string",
"addresses": [
{
"addressLabel": "string",
"contactName": "string",
"districtCode": "string",
"location": "string",
"street": "string",
"latitude": "string",
"longitude": "string",
"postalCode": "string",
"isPrimary": "boolean",
"salesChannel": "string"
}
],
"email": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"phone": "string",
"dateOfBirth": "number",
"createdAt": "number",
"updatedAt": "number",
"level": "string",
"loyaltyPoint": {
"amount": "number",
"history": [
{
"delta": "number",
"happenedAt": "number",
"info": "string"
}
]
},
"membership": {
"point": "number",
"history": [
{
"delta": "number",
"happenedAt": "number",
"info": "string"
}
]
},
"membershipModel": {
"ID": "string",
"type": "string",
"brandID": "string",
"pointProvider": "string",
"membershipLevel": "string",
"percentageOfPointFromTotalPurchase": "number",
"discount": "number",
"isActive": "boolean",
"maximumPointToExchangePerTransaction": "number",
"minimumPointToExchangePerTransaction": "number",
"minimumMoneyToSpendPerTransaction": "number"
}
}
}
AccountDetails: object
- ID:
- brandID:
- email:
- firstName:
- lastName:
- gender:
- phone:
- createdAt:
- updatedAt:
- dateOfBirth:
- addresses:
Example
{
"ID": "object",
"brandID": "object",
"email": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"phone": "string",
"createdAt": "number",
"updatedAt": "number",
"dateOfBirth": "object",
"addresses": [
{
"addressLabel": "string",
"contactName": "string",
"location": "string",
"street": "string",
"latitude": "string",
"longitude": "string",
"postalCode": "string",
"isPrimary": "boolean",
"districtCode": "string"
}
]
}
AddAdminInput: object
- spec:
-
List of specs to be added as admin
Example
{
"spec": [
{
"info": {
"email": "string",
"phone": "string",
"name": "string",
"tenantID": "string",
"brandIDs": [
"string"
],
"allBrand": "boolean"
},
"permission": {
"actions": [
"string"
],
"allAction": "boolean"
}
}
]
}
AddMembershipPointInput: object
- specs:
Example
{
"specs": [
{
"brandID": "object",
"memberID": "object",
"value": "number",
"pointProvider": "string",
"info": "string"
}
]
}
AddStockReminderCustomerInput: object
- productID:
- sku:
- contact:
- type:
Example
{
"productID": "string",
"sku": "string",
"contact": "string",
"type": "string"
}
AddressInput: object
- name:
- email:
- phone:
- country:
- province:
- city:
- subDistrict:
- street:
- districtCode:
- postalCode:
Example
{
"name": "string",
"email": "string",
"phone": "string",
"country": "string",
"province": "string",
"city": "string",
"subDistrict": "string",
"street": "string",
"districtCode": "string",
"postalCode": "string"
}
Addresses: object
- addressLabel:
- contactName:
- location:
- street:
- latitude:
- longitude:
- postalCode:
- isPrimary:
- districtCode:
Example
{
"addressLabel": "string",
"contactName": "string",
"location": "string",
"street": "string",
"latitude": "string",
"longitude": "string",
"postalCode": "string",
"isPrimary": "boolean",
"districtCode": "string"
}
Admin: object
- accountID:
- ID:
- addresses:
- email:
- firstName:
- lastName:
- gender:
- phone:
- dateOfBirth:
- createdAt:
- updatedAt:
Example
{
"accountID": "string",
"ID": "string",
"addresses": [
{
"addressLabel": "string",
"contactName": "string",
"districtCode": "string",
"street": "string",
"latitude": "string",
"longitude": "string",
"postalCode": "string",
"isPrimary": "boolean",
"salesChannel": "string"
}
],
"email": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"phone": "string",
"dateOfBirth": "number",
"createdAt": "number",
"updatedAt": "number"
}
AdminAddress: object
- addressLabel:
- contactName:
- districtCode:
- street:
- latitude:
- longitude:
- postalCode:
- isPrimary:
- salesChannel:
Example
{
"addressLabel": "string",
"contactName": "string",
"districtCode": "string",
"street": "string",
"latitude": "string",
"longitude": "string",
"postalCode": "string",
"isPrimary": "boolean",
"salesChannel": "string"
}
AdminAddressInput: object
- addressLabel:
-
Label for this address.
- contactName:
-
Contact name for this address.
- districtCode:
-
District code for this address.
- street:
-
This address' street name.
- latitude:
-
This address' latitude.
- longitude:
-
This address' longitude.
- postalCode:
-
Postal code for this address.
- isPrimary:
-
A flag to indicate whether this is a primary address or not.
Example
{
"addressLabel": "string",
"contactName": "string",
"districtCode": "string",
"street": "string",
"latitude": "string",
"longitude": "string",
"postalCode": "string",
"isPrimary": "boolean"
}
AdminProfile: object
- ID:
- firstName:
- lastName:
- email:
- phone:
- passwordIsSet:
- permission:
- apiKey:
- lastLogin:
- role:
Example
{
"ID": "object",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"passwordIsSet": "boolean",
"permission": {
"actions": [
"string"
],
"administeredBrandIDs": [
"string"
],
"allAction": "boolean"
},
"apiKey": {
"clientId": "string",
"clientSecret": "string"
},
"lastLogin": "number",
"role": "string"
}
AdminSpec: object
- info:
- permission:
Example
{
"info": {
"email": "string",
"phone": "string",
"name": "string",
"tenantID": "string",
"brandIDs": [
"string"
],
"allBrand": "boolean"
},
"permission": {
"actions": [
"string"
],
"allAction": "boolean"
}
}
Airwaybill: object
- products:
- recipientData:
- extraAttributes:
- providerService:
- customerSMCode:
- providerName:
- orderNumber:
- senderPhone:
- senderName:
- awbNumber:
- orderDate:
- remarks:
- smCode:
- logo:
Example
{
"products": [
{
"productCode": "string",
"productFid": "string",
"quantity": "number",
"title": "string",
"price": "number"
}
],
"recipientData": {
"phoneNumber": "string",
"postCode": "string",
"district": "string",
"address": "string",
"name": "string"
},
"extraAttributes": {
"customerSMCode": "string",
"isDropship": "boolean",
"SMCode": "string"
},
"providerService": "string",
"customerSMCode": "string",
"providerName": "string",
"orderNumber": "string",
"senderPhone": "string",
"senderName": "string",
"awbNumber": "string",
"orderDate": "string",
"remarks": "string",
"smCode": "string",
"logo": "string"
}
AnalyticsSetting: object
- facebookSetting:
- googleSetting:
Example
{
"facebookSetting": {
"accessToken": "string",
"catalogId": "string",
"pixelId": "string"
},
"googleSetting": {
"universalAnalytics": {
"trackingId": "string"
}
}
}
AppliedInput: object
- brandIds:
- slug:
- SKUs:
- collectionIDs:
- query:
- filter:
- source:
- sort:
- page:
Example
{
"brandIds": [
"string"
],
"slug": "string",
"SKUs": [
"string"
],
"collectionIDs": [
"string"
],
"query": {
"text": "string",
"language": "string"
},
"filter": {
"channelID": "string",
"channelIDs": [
"string"
],
"minimumPrice": "number",
"maximumPrice": "number",
"maximumStock": "number",
"minimumStock": "number",
"currencyCode": "string",
"published": "boolean",
"tagName": "string",
"tagNames": [
"string"
],
"collectionSlugs": [
"string"
],
"openOrder": "boolean",
"openOrderScheduled": "boolean",
"partiallyOutOfStock": "boolean",
"variantOptionSpecs": [
{
"optionKey": "string",
"optionValue": "string"
}
]
},
"source": "boolean",
"sort": [
{
"fieldName": "string",
"isAscending": "boolean"
}
],
"page": {
"pageNumber": "number",
"itemPerPage": "number"
}
}
Article: object
- ID:
- articleID:
- categoryID:
- category:
- slug:
- descriptions:
- SEOs:
- isActive:
Example
{
"ID": "string",
"articleID": "string",
"categoryID": "string",
"category": {
"categoryID": "string",
"imageURL": "string",
"translations": [
{
"language": "string",
"name": "string"
}
],
"SEOs": [
{
"language": "string",
"title": "string",
"description": "string",
"keywords": [
"string"
]
}
],
"isActive": "boolean",
"displayType": "string",
"slug": "string"
},
"slug": "string",
"descriptions": [
{
"language": "string",
"title": "string",
"content": "string"
}
],
"SEOs": [
{
"language": "string",
"title": "string",
"description": "string",
"keywords": [
"string"
]
}
],
"isActive": "boolean"
}
ArticleCategory: object
- categoryID:
- imageURL:
- translations:
- SEOs:
- isActive:
- displayType:
- slug:
Example
{
"categoryID": "string",
"imageURL": "string",
"translations": [
{
"language": "string",
"name": "string"
}
],
"SEOs": [
{
"language": "string",
"title": "string",
"description": "string",
"keywords": [
"string"
]
}
],
"isActive": "boolean",
"displayType": "string",
"slug": "string"
}
ArticleCategoryFilterInput: object
- displayType:
- isActive:
Example
{
"displayType": "string",
"isActive": "boolean"
}
ArticleFilterInput: object
- displayType:
- categoryID:
Example
{
"displayType": "string",
"categoryID": "string"
}
BankAccount: object
- banks:
Example
{
"banks": [
{
"name": "string",
"accountNumber": "string",
"accountName": "string",
"isActive": "boolean"
}
]
}
BankInput: object
- name:
-
Name of the bank.
- accountNumber:
-
Account number for that bank.
- accountName:
-
Account name for that bank.
- isActive:
-
A flag to indicate whether this bank is active or not.
Example
{
"name": "string",
"accountNumber": "string",
"accountName": "string",
"isActive": "boolean"
}
BankSettingInput: object
- banks:
-
Banks for the bank setting.
Example
{
"banks": [
{
"name": "string",
"accountNumber": "string",
"accountName": "string",
"isActive": "boolean"
}
]
}
Banner: object
- ID:
- imageURL:
- targetURL:
- translations:
- activeStartTime:
- activeEndTime:
- published:
- ordering:
Example
{
"ID": "string",
"imageURL": "string",
"targetURL": "string",
"translations": [
{
"language": "string",
"title": "string",
"description": "string"
}
],
"activeStartTime": "number",
"activeEndTime": "number",
"published": "boolean",
"ordering": "number"
}
BannerFilterInput: object
- translation:
- activeAtTime:
Example
{
"translation": {
"language": "string",
"title": "string",
"description": "string"
},
"activeAtTime": "number"
}
BannerInput: object
- bannerID:
-
Omit this to create a new banner
- imageURL:
- targetURL:
- activeStartTime:
- activeEndTime:
- published:
- ordering:
- translations:
Example
{
"bannerID": "string",
"imageURL": "string",
"targetURL": "string",
"activeStartTime": "number",
"activeEndTime": "number",
"published": "boolean",
"ordering": "number",
"translations": [
{
"language": "string",
"title": "string",
"description": "string"
}
]
}
Billing: object
- tenants:
- marketingTenants:
- subscriptions:
- invoices:
Example
{
"tenants": {
"items": [
{
"ID": "object",
"name": "string",
"email": "string",
"phone": "string",
"balance": "string"
}
],
"pageInfo": {
"totalItems": "number",
"itemPerPage": "number",
"pageNumber": "number"
}
},
"marketingTenants": {
"items": [
{
"ID": "object",
"dateCreated": "string",
"salutation": "string",
"firstName": "string",
"dateOfBirth": "string",
"email": "string",
"alternatifEmail": "string",
"phoneNumber": "string",
"alternatifPhoneNumber": "string",
"addressLine": "string",
"postalCode": "string",
"state": "string",
"country": "string"
}
],
"pageInfo": {
"totalItems": "number",
"itemPerPage": "number",
"pageNumber": "number"
}
},
"subscriptions": [
{
"ID": "object",
"storeName": "string",
"planType": "string",
"planName": "string",
"startDate": "string",
"endDate": "string",
"price": "number"
}
],
"invoices": [
{
"ID": "object",
"amount": "number",
"brandID": "string",
"creditAdj": "number",
"invoiceDate": "string",
"invoiceNumber": "string",
"status": "string",
"items": [
{}
]
}
]
}
BillingInfo: object
- salutation:
- fullName:
- addressLine:
- district:
- city:
- province:
- country:
- phoneNumber:
- email:
- postalCode:
Example
{
"salutation": "string",
"fullName": "string",
"addressLine": "string",
"district": "string",
"city": "string",
"province": "string",
"country": "string",
"phoneNumber": "string",
"email": "string",
"postalCode": "string"
}
BirthdayCoupon: object
- ID:
- couponID:
- brandID:
- brand:
- code:
- type:
- title:
- isActive:
- isValid:
- salesChannel:
- couponType:
- maximumUsageCount:
- applicableStartTimestamp:
- applicableEndTimestamp:
- discountValue:
- usages:
- validityPeriod:
- minimumPurchase:
Example
{
"ID": "string",
"couponID": "string",
"brandID": "string",
"brand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string"
}
]
}
}
}
]
}
}
}
]
}
}
}
]
}
}
}
}
BootstrapBrandInput: object
- brandID:
- email:
- firstName:
- lastName:
- password:
- phone:
- country:
- districtCode:
- template:
- ssoInfo:
Example
{
"brandID": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"password": "string",
"phone": "string",
"country": "string",
"districtCode": "string",
"template": "string",
"ssoInfo": {
"idToken": "string",
"provider": "string"
}
}
Brand: object
- ID:
- name:
- tenantID:
- tenant:
-
Query tenant related to Brand
- logoURL:
- settings:
-
Query setting for specific brand
- orders:
-
Query order within brand.
'query' is prioritized, 'filter' is only used if 'query' is not specfied
- products:
-
Query products within brand.
- productRecommendations:
-
Query product recommendations.
- productReviews:
-
Query product reviews within brand.
- productVariants:
-
Query product variants
- collections:
-
Query collections from procol service
- members:
-
Query members from account service (Raiden)
'query' is prioritized, 'filter' is only used if 'query' is not specfied
- widgets:
-
Query widgets
- articles:
-
Query articles
- article:
-
Query article by its slug
- cart:
-
Query saved cart
- memberCart:
-
Query saved member cart
- dryRunImport:
-
Query dry run import
- exportExcel:
-
General Query to generate excel files
- eximHistory:
- report:
- discounts:
-
Query discounts
- articleCategories:
-
Query article's categories
- analyticsSetting:
-
Query analytic's setting
- navigations:
-
Query navigations
- notificationTemplates:
-
Query templates for notification
- notificationTemplatesV2:
-
Query templates for notificationV2
- notificationHistory:
-
Query history for notification
- bundles:
-
Query bundles
- coupons:
-
Query coupons
-
validCoupons:
object[]
-
Query valid coupons for specific cart condition
- lookbook:
-
Query lookbook by slug
- lookbooks:
-
Query lookbooks
- paymentProviders:
-
Query payment provider
- paymentAvailability:
- shippingCost:
-
Query shipping cost
- shippingCostEstimation:
-
Query estimate shipping cost
- shippings:
-
Query shipping provider
- banners:
-
Query banners
- promotions:
-
Query promotions
- marketplaces:
-
Query all marketplaces channels
- marketplaceConnectionForms:
-
Query all marketplaces integration fields
- salesChannels:
-
Query all sales channels
- socmedSetting:
-
Query socmed's setting
- testimonials:
-
Query testimonials
- isExpired:
-
Expiry status of the brand
- fqdn:
-
Fully qualified domain name of the brand
- newsletter:
-
Query newsletters
- linkspage:
-
Query linkspage
- productTags:
-
Query productTags
- googleAdsWebsiteMetaToken:
-
Get website meta token for googleads
- googleAccountLoginURL:
-
Get login url
- googleAdsReport:
-
Get google ads report
- googleAdsRelatedAccounts:
-
Get google ads related account
- googleAdsEligibilityStatus:
-
Get google ads brand eligibility status
- googleAdsCampaign:
-
Get google ads campaign
- planActions:
-
Get brand's plan actions
Example
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string"
}
}
]
}
}
}
]
}
}
}
]
}
}
}
]
}
}
}
BrandMembershipSetting: object
- brandID:
- freePointForNewMember:
- ignorePointExpiry:
- mainMembershipModel:
- minimumPointToExchange:
- pointForNewMember:
- usePointForDiscount:
Example
{
"brandID": "object",
"freePointForNewMember": "boolean",
"ignorePointExpiry": "boolean",
"mainMembershipModel": "string",
"minimumPointToExchange": "number",
"pointForNewMember": "number",
"usePointForDiscount": "boolean"
}
BrandPaymentProvider: object
- ID:
- brandID:
- name:
- logo:
- isActive:
- paymentMethods:
- formFields:
- configs:
Example
{
"ID": "object",
"brandID": "object",
"name": "string",
"logo": "string",
"isActive": "boolean",
"paymentMethods": [
{
"ID": "object",
"providerID": "object",
"brandID": "object",
"name": "string",
"logo": "string",
"isActive": "boolean",
"formFields": [
{
"label": "string",
"name": "string",
"type": "string",
"description": "string",
"isRequired": "boolean",
"options": [
"string"
],
"conditionalShows": [
{
"formFieldName": "string",
"condition": "string"
}
]
}
],
"configs": [
{
"ID": "string",
"providerID": "string",
"method": "string",
"configs": [
{
"name": "string",
"value": "string"
}
]
}
]
}
],
"formFields": [
{
"label": "string",
"name": "string",
"type": "string",
"description": "string",
"isRequired": "boolean",
"options": [
"string"
],
"conditionalShows": [
{
"formFieldName": "string",
"condition": "string"
}
]
}
],
"configs": [
{
"ID": "string",
"providerID": "string",
"method": "string",
"configs": [
{}
]
}
]
}
BrandPaymentProviderMethod: object
- ID:
- providerID:
- brandID:
- name:
- logo:
- isActive:
- formFields:
- configs:
Example
{
"ID": "object",
"providerID": "object",
"brandID": "object",
"name": "string",
"logo": "string",
"isActive": "boolean",
"formFields": [
{
"label": "string",
"name": "string",
"type": "string",
"description": "string",
"isRequired": "boolean",
"options": [
"string"
],
"conditionalShows": [
{
"formFieldName": "string",
"condition": "string"
}
]
}
],
"configs": [
{
"ID": "string",
"providerID": "string",
"method": "string",
"configs": [
{
"name": "string",
"value": "string"
}
]
}
]
}
BrandReport: object
- salesByMember:
- bestSellingProduct:
- monthlySales:
Example
{
"salesByMember": {
"items": [
{
"brandID": "string",
"email": "string",
"memberID": "string",
"orderCount": "number",
"orderDate": "number",
"totalDiscount": {
"code": "string",
"value": "number"
},
"totalOrderAmount": {
"code": "string",
"value": "number"
},
"totalShippingFee": {
"code": "string",
"value": "number"
}
}
],
"pageInfo": {
"totalItems": "number",
"itemPerPage": "number",
"pageNumber": "number"
}
},
"bestSellingProduct": {
"items": [
{
"brandID": "string",
"orderCount": "number",
"productName": "string",
"productSKU": "string",
"revenue": {
"code": "string",
"value": "number"
},
"soldQuantity": "number"
}
],
"pageInfo": {
"totalItems": "number",
"itemPerPage": "number",
"pageNumber": "number"
}
},
"monthlySales": {
"items": [
{
"brandID": "string",
"orderCount": "number",
"productSales": [
{
"orderCount": "number",
"productName": "string",
"productSKU": "string",
"soldQuantity": "number",
"totalNetRevenue": {
"code": "string",
"value": "number"
}
}
],
"soldQuantity": "number"
}
]
}
}
BrandSetting: object
- adminEmail:
- bankAccount:
- brandID:
- checkoutAsGuestEnabled:
- confirmPaymentMessage:
- faviconURL:
- hideFromSearchEngine:
- newsletter:
- paymentMethods:
- productFilterAndSort:
- productOption:
- reviewsAndRatingEnabled:
- setAsMaintenance:
- socialMediaLink:
- instagramToken:
- instagramTokenLastUpdated:
- websiteDescription:
- websiteTitle:
- defaultMembershipLevel:
- facebookAnalytics:
- googleAnalytics:
- privyID:
- notificationCCEmail:
- pushNotification:
- googleAuth:
- defaultExchangePointSettingID:
- exchangePointSetting:
-
'query' is prioritized, 'filter' is only used if 'query' is not specfied
- stockReminderEnabled:
- noReplyEmail:
Example
{
"adminEmail": "string",
"bankAccount": {
"banks": [
{
"name": "string",
"accountNumber": "string",
"accountName": "string",
"isActive": "boolean"
}
]
},
"brandID": "string",
"checkoutAsGuestEnabled": "boolean",
"confirmPaymentMessage": {
"isActive": "boolean",
"message": "string"
},
"faviconURL": "string",
"hideFromSearchEngine": "boolean",
"newsletter": {
"popupOnFirstVisit": "boolean",
"content": "string"
},
"paymentMethods": {
"paymentMethods": [
{
"name": "string",
"merchantID": "string",
"clientKey": "string",
"serverKey": "string",
"acquiringBank": "string",
"payPalAccount": "string",
"specs": [
{
"method": "string",
"isActive": "boolean",
"chargeFeeToCustomer": "boolean",
"expiryHour": "number"
}
]
}
]
},
"productFilterAndSort": {
"filters": [
{
"name": "string",
"isActive": "boolean",
"type": "string",
"variantSpecs": [
{
"key": "string",
"translations": [
{
"language": "string",
"text": "string"
}
],
"options": [
{
"attributes": [
{
"key": "string",
"value": "string"
}
],
"isActive": "boolean",
"translations": [
null
]
}
]
}
]
}
]
}
}
BundleFilterCriteriaSpec: object
- isActive:
- priority:
- startTime:
- endTime:
- bundleType:
Example
{
"isActive": "boolean",
"priority": "number",
"startTime": "number",
"endTime": "number",
"bundleType": [
"string"
]
}
BundleRuleType: string
-
objectBuyNItemRule
-
objectBuyMinQuantityGetFreeItemsRule
-
objectBuyMinAmountGetFreeItemsRule
BundleType: string
-
objectBuyNItemRule
-
objectBuyMinQuantityGetFreeItemsRule
-
objectBuyMinAmountGetFreeItemsRule
BuyMinAmountGetFreeItemsBundle: object
- ID:
- title:
- startTime:
- endTime:
- isActive:
- ruleType:
- priority:
- salesChannel:
- minAmountToBuy:
- eligibleProducts:
- bundledProductsList:
Example
{
"ID": "string",
"title": "string",
"startTime": "number",
"endTime": "number",
"isActive": "boolean",
"ruleType": "string",
"priority": "number",
"salesChannel": "string",
"minAmountToBuy": {
"code": "string",
"value": "number"
},
"eligibleProducts": [
{
"ID": "object",
"brandID": "object",
"brand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string"
}
]
}
}
}
]
}
}
}
]
}
}
}
}
]
}
BuyMinAmountGetFreeItemsBundleInput: object
- ID:
- title:
- startTime:
- endTime:
- isActive:
- priority:
- minAmountToBuy:
- eligibleProductIDs:
- bundledProducts:
Example
{
"ID": "string",
"title": "string",
"startTime": "number",
"endTime": "number",
"isActive": "boolean",
"priority": "number",
"minAmountToBuy": {
"code": "string",
"value": "number"
},
"eligibleProductIDs": [
"string"
],
"bundledProducts": [
{
"ID": "string",
"price": {
"code": "string",
"value": "number"
},
"quantity": "number"
}
]
}
BuyMinQuantityGetFreeItemsBundle: object
- ID:
- title:
- startTime:
- endTime:
- isActive:
- ruleType:
- priority:
- salesChannel:
- minQuantityToBuy:
- eligibleProducts:
- bundledProductsList:
Example
{
"ID": "string",
"title": "string",
"startTime": "number",
"endTime": "number",
"isActive": "boolean",
"ruleType": "string",
"priority": "number",
"salesChannel": "string",
"minQuantityToBuy": "number",
"eligibleProducts": [
{
"ID": "object",
"brandID": "object",
"brand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {}
}
]
}
}
}
]
}
}
}
]
}
}
}
}
]
}
BuyMinQuantityGetFreeItemsBundleInput: object
- ID:
- title:
- startTime:
- endTime:
- isActive:
- priority:
- minQuantityToBuy:
- eligibleProductIDs:
- bundledProducts:
Example
{
"ID": "string",
"title": "string",
"startTime": "number",
"endTime": "number",
"isActive": "boolean",
"priority": "number",
"minQuantityToBuy": "number",
"eligibleProductIDs": [
"string"
],
"bundledProducts": [
{
"ID": "string",
"price": {
"code": "string",
"value": "number"
},
"quantity": "number"
}
]
}
BuyNItemBundle: object
- ID:
- title:
- startTime:
- endTime:
- isActive:
- ruleType:
- priority:
- salesChannel:
- numOfItemToBuy:
- eligibleProducts:
- fixedPrice:
Example
{
"ID": "string",
"title": "string",
"startTime": "number",
"endTime": "number",
"isActive": "boolean",
"ruleType": "string",
"priority": "number",
"salesChannel": "string",
"numOfItemToBuy": "number",
"eligibleProducts": [
{
"ID": "object",
"brandID": "object",
"brand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {}
}
]
}
}
}
]
}
}
}
]
}
}
}
}
]
}
BuyNItemBundleInput: object
- ID:
- title:
- startTime:
- endTime:
- isActive:
- priority:
- numOfItemToBuy:
- eligibleProductIDs:
- fixedPrice:
Example
{
"ID": "string",
"title": "string",
"startTime": "number",
"endTime": "number",
"isActive": "boolean",
"priority": "number",
"numOfItemToBuy": "number",
"eligibleProductIDs": [
"string"
],
"fixedPrice": {
"code": "string",
"value": "number"
}
}
Buyer: object
- id:
- name:
- channel:
- isRead:
- lastMessage:
- lastAlert:
- timestamp:
- type:
- lastMessageId:
- isArchived:
- createdAt:
- updatedAt:
- unreadCount:
- message_id:
- attributes:
- session:
- userId:
Example
{
"id": "object",
"name": "string",
"channel": "string",
"isRead": "boolean",
"lastMessage": "string",
"lastAlert": "string",
"timestamp": "number",
"type": "string",
"lastMessageId": "number",
"isArchived": "boolean",
"createdAt": "string",
"updatedAt": "string",
"unreadCount": "number",
"message_id": "string",
"attributes": [
{
"id": "number",
"chatRoomId": "number",
"key": "string",
"value": "string"
}
],
"session": "string",
"userId": "string"
}
BuyerDetail: object
- id:
- name:
- channel:
- isRead:
- lastMessageId:
- isArchived:
- createdAt:
- updatedAt:
- unreadCount:
Example
{
"id": "string",
"name": "string",
"channel": "string",
"isRead": "boolean",
"lastMessageId": "number",
"isArchived": "boolean",
"createdAt": "string",
"updatedAt": "string",
"unreadCount": "number"
}
BuyersInput: object
- sellerId:
- channel:
- scroll:
- id:
- buyerId:
- limit:
- userId:
- show:
- session:
Example
{
"sellerId": "object",
"channel": "string",
"scroll": "string",
"id": "string",
"buyerId": "object",
"limit": "number",
"userId": "string",
"show": "string",
"session": "string"
}
CartAddress: object
- districtCode:
- email:
- name:
- phone:
- postalCode:
- street:
- location:
- longLat:
Example
{
"districtCode": "string",
"email": "string",
"name": "string",
"phone": "string",
"postalCode": "string",
"street": "string",
"location": {
"country": "string",
"province": "string",
"city": "string",
"district": "string"
},
"longLat": "string"
}
CartAddressInput: object
- districtCode:
-
The district code of this cart's address.
- email:
-
The email used for this cart's address.
- name:
-
The name used for this cart's address.
- phone:
-
The phone number used for this cart's address.
- postalCode:
-
The postal code of this cart's address.
- street:
-
The street name of this cart's address.
- longLat:
-
The longitude and latitude combined of this cart's address
Example
{
"districtCode": "string",
"email": "string",
"name": "string",
"phone": "string",
"postalCode": "string",
"street": "string",
"longLat": "string"
}
CartAppliedPromo: object
- typeId:
- type:
- title:
- code:
- priceCut:
Example
{
"typeId": "string",
"type": "string",
"title": "string",
"code": "string",
"priceCut": {
"code": "string",
"value": "number"
}
}
CartCoupon: object
- ID:
- couponID:
- brandID:
- brand:
- code:
- type:
- title:
- isActive:
- isValid:
- salesChannel:
- couponType:
- maximumUsageCount:
- applicableStartTimestamp:
- applicableEndTimestamp:
- discountValue:
- usages:
- isMemberOnly:
- allowedMemberLevels:
- minimumPurchase:
Example
{
"ID": "string",
"couponID": "string",
"brandID": "string",
"brand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string"
}
]
}
}
}
]
}
}
}
]
}
}
}
]
}
}
}
}
CartLineItem: object
- imageURL:
- price:
- quantity:
- SKU:
- title:
- availableStock:
- ignoreStock:
- errorMessage:
- discount:
- slug:
- salePrice:
- maxDiscountedItem:
- weight:
- volume:
Example
{
"imageURL": "string",
"price": {
"code": "string",
"value": "number"
},
"quantity": "number",
"SKU": "string",
"title": "string",
"availableStock": "number",
"ignoreStock": "boolean",
"errorMessage": "string",
"discount": {
"code": "string",
"value": "number"
},
"slug": "string",
"salePrice": {
"code": "string",
"value": "number"
},
"maxDiscountedItem": "number",
"weight": {
"value": "number",
"unit": "string"
},
"volume": {
"length": "number",
"height": "number",
"width": "number",
"unit": "string"
}
}
CartLineItemInput: object
- imageURL:
-
URL of this line item's image.
- price:
-
The price for this line item.
- quantity:
-
The quantity for this line item.
- SKU:
-
SKU for this line item.
- title:
-
The title for this line item.
Example
{
"imageURL": "string",
"price": {
"code": "string",
"value": "number"
},
"quantity": "number",
"SKU": "string",
"title": "string"
}
CartPaymentInput: object
- fee:
-
Fee of this payment.
- provider:
-
The provider used for this payment.
- service:
-
The service used for this payment.
- uniqueCode:
-
The unique code for this payment.
Example
{
"fee": {
"code": "string",
"value": "number"
},
"provider": "string",
"service": "string",
"uniqueCode": "number"
}
CartPromo: object
- totalDiscount:
- appliedPromos:
Example
{
"totalDiscount": {
"code": "string",
"value": "number"
},
"appliedPromos": [
{
"typeId": "string",
"type": "string",
"title": "string",
"code": "string",
"priceCut": {
"code": "string",
"value": "number"
}
}
]
}
CartShippingInput: object
- awbNumber:
-
Airway bill number of this cart's shipping.
- cost:
-
The cost of shipping.
- provider:
-
The provider used for this shipping.
- service:
-
The service used for this shipping.
Example
{
"awbNumber": "string",
"cost": {
"code": "string",
"value": "number"
},
"provider": "string",
"service": "string"
}
ChangePasswordInput: object
- data:
-
Required data for changing password.
- isAdmin:
-
A flag to indicate whether this user is an admin or not.
Example
{
"data": {
"accountID": "string",
"oldPassword": "string",
"newPassword": "string"
},
"isAdmin": "boolean"
}
ChatSettings: object
- sellerId:
- about:
- photoUrl:
- address:
- description:
- email:
- vertical:
- websites:
Example
{
"sellerId": "string",
"about": "string",
"photoUrl": "string",
"address": "string",
"description": "string",
"email": "string",
"vertical": "string",
"websites": [
"string"
]
}
ChatUser: object
- id:
- userEmail:
- createdAt:
- phoneNumber:
- storeName:
- whatsappNamespace:
- brandId:
- isNotifOn:
- buyersInputShow:
- buyers:
Example
{
"id": "object",
"userEmail": "string",
"createdAt": "number",
"phoneNumber": "string",
"storeName": "string",
"whatsappNamespace": "string",
"brandId": "string",
"isNotifOn": "boolean",
"buyersInputShow": "string",
"buyers": [
{
"id": "object",
"name": "string",
"channel": "string",
"isRead": "boolean",
"lastMessage": "string",
"lastAlert": "string",
"timestamp": "number",
"type": "string",
"lastMessageId": "number",
"isArchived": "boolean",
"createdAt": "string",
"updatedAt": "string",
"unreadCount": "number",
"message_id": "string",
"attributes": [
{
"id": "number",
"chatRoomId": "number",
"key": "string",
"value": "string"
}
],
"session": "string",
"userId": "string"
}
]
}
ClaimChatQueueRes: object
- buyerId:
- buyerName:
- channel:
- isRead:
- lastMessageId:
- lastMessage:
- lastAlert:
- timestamp:
- messageType:
Example
{
"buyerId": "string",
"buyerName": "string",
"channel": "string",
"isRead": "boolean",
"lastMessageId": "number",
"lastMessage": "string",
"lastAlert": "string",
"timestamp": "number",
"messageType": "string"
}
ClaimGoogleMerchantWebsiteInput: object
- brandID:
-
The ID of the brand.
Example
{
"brandID": "object"
}
Collection: object
- ID:
- slug:
- details:
- imageURLs:
- published:
- channelIDs:
- SEOs:
- attributes:
- parentIDs:
- aggregate:
Example
{
"ID": "object",
"slug": "string",
"details": [
{
"name": "string",
"description": "string",
"language": "string"
}
],
"imageURLs": [
"string"
],
"published": "boolean",
"channelIDs": [
"object"
],
"SEOs": [
{
"title": "string",
"description": "string",
"keywords": [
"string"
],
"language": "string"
}
],
"attributes": [
{
"key": "string",
"value": "string"
}
],
"parentIDs": [
"object"
],
"aggregate": {
"totalPublishedProduct": "number"
}
}
CollectionUpsertInput: object
- brandID:
- ID:
-
Omit this to create a new collection
- slug:
-
Must be unique per product
- details:
- imageURLs:
- published:
- channelIDs:
- SEOs:
- attributes:
- parentIDs:
-
Omit this to create new parent collection
Example
{
"brandID": "object",
"ID": "object",
"slug": "string",
"details": [
{
"name": "string",
"description": "string",
"language": "string"
}
],
"imageURLs": [
"string"
],
"published": "boolean",
"channelIDs": [
"object"
],
"SEOs": [
{
"title": "string",
"description": "string",
"keywords": [
"string"
],
"language": "string"
}
],
"attributes": [
{
"key": "string",
"value": "string"
}
],
"parentIDs": [
"object"
]
}
Country: object
Example
{
"locationCode": "string",
"providerData": "string",
"provinces": [
{
"locationCode": "string",
"providerData": "string",
"cities": [
{
"locationCode": "string",
"providerData": "string",
"districts": [
{
"locationCode": "string",
"providerData": "string"
}
]
}
]
}
]
}
CouponFilterInput: object
- salesChannels:
- isMemberOnly:
- memberLevel:
- shippingMethod:
- paymentMethod:
- applicableSKUs:
- couponType:
- applicableStartTimestamp:
- applicableEndTimestamp:
- isActive:
Example
{
"salesChannels": [
"string"
],
"isMemberOnly": "boolean",
"memberLevel": "string",
"shippingMethod": "string",
"paymentMethod": "string",
"applicableSKUs": [
"string"
],
"couponType": "string",
"applicableStartTimestamp": "number",
"applicableEndTimestamp": "number",
"isActive": "boolean"
}
CouponSortInput: object
- fieldName:
- isAscending:
Example
{
"fieldName": "string",
"isAscending": "boolean"
}
CouponValidInput: object
- memberID:
- memberLevel:
- items:
- shippingMethod:
- paymentMethod:
- date:
- totalCost:
Example
{
"memberID": "string",
"memberLevel": "string",
"items": [
{
"sku": "string",
"quantity": "number",
"basePrice": {
"code": "string",
"value": "number"
}
}
],
"shippingMethod": "string",
"paymentMethod": "string",
"date": "number",
"totalCost": {
"code": "string",
"value": "number"
}
}
CreateArticlesInput: object
- brandID:
-
Brand ID to put this article in.
- specs:
-
Specifications for creating articles.
Example
{
"brandID": "object",
"specs": [
{
"categoryID": "object",
"slug": "string",
"descriptions": [
{
"language": "string",
"title": "string",
"content": "string"
}
],
"SEOs": [
{
"language": "string",
"title": "string",
"description": "string",
"keywords": [
"string"
]
}
],
"isActive": "boolean"
}
]
}
CreateArticlesSpec: object
- categoryID:
-
Category ID to put this article in.
- slug:
-
Slug for this article.
- descriptions:
-
Descriptions for this article.
- SEOs:
-
Article's search engine optimations.
- isActive:
-
A flag to indicate whether this article is active or not.
Example
{
"categoryID": "object",
"slug": "string",
"descriptions": [
{
"language": "string",
"title": "string",
"content": "string"
}
],
"SEOs": [
{
"language": "string",
"title": "string",
"description": "string",
"keywords": [
"string"
]
}
],
"isActive": "boolean"
}
CreateEnquiryInput: object
- brandID:
- specs:
-
Specifications for create testimonials input.
Example
{
"brandID": "string",
"specs": [
{
"email": "string",
"message": "string",
"name": "string",
"phone": "string",
"referer": "string",
"subject": "string",
"customFields": [
{
"key": "string",
"value": "string"
}
],
"createdAt": "number",
"updatedAt": "number"
}
]
}
CreateEnquirySpec: object
- email:
- message:
- name:
- phone:
- referer:
- subject:
- customFields:
- createdAt:
- updatedAt:
Example
{
"email": "string",
"message": "string",
"name": "string",
"phone": "string",
"referer": "string",
"subject": "string",
"customFields": [
{
"key": "string",
"value": "string"
}
],
"createdAt": "number",
"updatedAt": "number"
}
CreateNewsletterSpec: object
- email:
-
The email that will receive newsletter.
Example
{
"email": "string"
}
CreateNewslettersInput: object
- brandID:
-
Brand ID to put the newsletter in.
- specs:
-
Specifications for creating newsletter input.
Example
{
"brandID": "string",
"specs": [
{
"email": "string"
}
]
}
CreateOrderInput: object
- brandID:
-
Brand ID to put this order in.
- specs:
-
Specifications for creating order.
Example
{
"brandID": "string",
"specs": [
{
"memberID": "string",
"invoiceID": "string",
"channelID": "string",
"discount": {
"code": "string",
"value": "number"
},
"totalCost": {
"code": "string",
"value": "number"
},
"buyerNote": "string",
"billingAddress": {
"name": "string",
"email": "string",
"phone": "string",
"country": "string",
"province": "string",
"city": "string",
"subDistrict": "string",
"street": "string",
"districtCode": "string",
"postalCode": "string"
},
"deliveryAddress": {
"name": "string",
"email": "string",
"phone": "string",
"country": "string",
"province": "string",
"city": "string",
"subDistrict": "string",
"street": "string",
"districtCode": "string",
"postalCode": "string"
},
"lineItems": [
{
"title": "string",
"SKU": "string",
"quantity": "number",
"price": {
"code": "string",
"value": "number"
},
"imageURL": "string"
}
],
"shipping": {
"provider": "string",
"service": "string",
"cost": {
"code": "string",
"value": "number"
}
}
}
]
}
CreateOrderParam: object
- billingInfo:
- shippingInfo:
- sameWithBillingInfo:
- items:
- payments:
- buyersMessage:
Example
{
"billingInfo": {
"salutation": "string",
"fullName": "string",
"addressLine": "string",
"district": "string",
"city": "string",
"province": "string",
"country": "string",
"phoneNumber": "string",
"email": "string",
"postalCode": "string"
},
"shippingInfo": {
"method": "string",
"cost": "number"
},
"sameWithBillingInfo": "boolean",
"items": [
{
"productCode": "string",
"quantity": "number"
}
],
"payments": {
"coupon": "string",
"method": "string"
},
"buyersMessage": "string"
}
CreateProductInput: object
- brandID:
-
Brand ID to put the product in.
- specs:
-
Specifications for creating product.
Example
{
"brandID": "object",
"specs": [
{
"details": [
{
"name": "string",
"description": "string",
"language": "string"
}
],
"volume": {
"length": "number",
"height": "number",
"width": "number",
"unit": "string"
},
"weight": {
"value": "number",
"unit": "string"
},
"imageURLs": [
"string"
],
"published": "boolean",
"variants": [
{
"SKU": "object",
"options": [
{
"key": "object",
"value": "string"
}
],
"basePrices": [
{
"code": "string",
"value": "number"
}
],
"channelIDs": [
"string"
],
"attributes": [
{
"sortIndex": "number",
"translations": [
{
"key": "string",
"value": "string",
"language": "string"
}
]
}
],
"channelAttributes": [
{
"channelID": "string",
"key": "object",
"value": "string"
}
],
"imageURLs": [
"string"
],
"stock": "number",
"ignoreStock": "boolean"
}
],
"slug": "string",
"SEOs": [
{
"title": "string",
"description": "string",
"keywords": [
"string"
]
}
]
}
]
}
CreateProductSpecInput: object
- details:
-
Details for the created product.
- volume:
-
Volume of the product.
- weight:
-
Weight of the product.
- imageURLs:
-
URL of the product's image.
- published:
-
A flag di indicate whether this product is published or not.
- variants:
-
Variants for create product specifications.
- slug:
-
Ths slug of the product. Must be unique.
- SEOs:
-
Search engine optimations for create product specifications
- condition:
-
Condition of the product.
- attributes:
-
Attributes for create product specifications.
- channelAttributes:
-
Channel attributes for create product specifications.
- relatedProductIds:
-
Other products that are related to this product.
- tagKeys:
-
Tags for this product.
- collectionIds:
-
List of collection IDs that have this product in them.
- schedulePublishAt:
-
Time when the product can be viewed.
- scheduleOpenOrderAt:
-
Time when the product can be ordered.
- scheduleCloseOrderAt:
-
Time when the product can't be ordered anymore.
Example
{
"details": [
{
"name": "string",
"description": "string",
"language": "string"
}
],
"volume": {
"length": "number",
"height": "number",
"width": "number",
"unit": "string"
},
"weight": {
"value": "number",
"unit": "string"
},
"imageURLs": [
"string"
],
"published": "boolean",
"variants": [
{
"SKU": "object",
"options": [
{
"key": "object",
"value": "string"
}
],
"basePrices": [
{
"code": "string",
"value": "number"
}
],
"channelIDs": [
"string"
],
"attributes": [
{
"sortIndex": "number",
"translations": [
{
"key": "string",
"value": "string",
"language": "string"
}
]
}
],
"channelAttributes": [
{
"channelID": "string",
"key": "object",
"value": "string"
}
],
"imageURLs": [
"string"
],
"stock": "number",
"ignoreStock": "boolean"
}
],
"slug": "string",
"SEOs": [
{
"title": "string",
"description": "string",
"keywords": [
"string"
],
"language": "string"
}
],
"condition": "string",
"attributes": [
null
]
}
CreateTemplateInput: object
- brandID:
- specs:
Example
{
"brandID": "object",
"specs": [
{
"emailTemplate": {
"buyer": {
"bccs": [
"string"
],
"ccs": [
"string"
],
"tos": [
"string"
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
},
"isActive": "boolean",
"seller": {
"bccs": [
"string"
],
"ccs": [
"string"
],
"tos": [
"string"
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
}
},
"event": {
"type": "string",
"version": "number"
},
"smsTemplate": {
"buyer": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
},
"isActive": "boolean",
"seller": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
}
},
"whatsAppTemplate": {
"buyer": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
},
"isActive": "boolean"
}
}
]
}
CreateTemplateSpec: object
- emailTemplate:
- event:
- smsTemplate:
- whatsAppTemplate:
Example
{
"emailTemplate": {
"buyer": {
"bccs": [
"string"
],
"ccs": [
"string"
],
"tos": [
"string"
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
},
"isActive": "boolean",
"seller": {
"bccs": [
"string"
],
"ccs": [
"string"
],
"tos": [
"string"
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
}
},
"event": {
"type": "string",
"version": "number"
},
"smsTemplate": {
"buyer": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
},
"isActive": "boolean",
"seller": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
}
},
"whatsAppTemplate": {
"buyer": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
},
"isActive": "boolean",
"seller": {
"targetPhoneNumbers": [
"string"
]
}
}
}
CreateTestimonialSpec: object
- email:
- author:
- company:
- website:
- memberID:
- productID:
- title:
- content:
-
Minimum 20 characters needed
- imageURLs:
- rating:
-
Between 1-5
- createdAt:
- updatedAt:
- published:
- isFeatured:
Example
{
"email": "string",
"author": "string",
"company": "string",
"website": "string",
"memberID": "string",
"productID": "string",
"title": "string",
"content": "string",
"imageURLs": [
"string"
],
"rating": "number",
"createdAt": "number",
"updatedAt": "number",
"published": "boolean",
"isFeatured": "boolean"
}
CreateTestimonialsInput: object
- brandID:
- specs:
-
Specifications for create testimonials input.
Example
{
"brandID": "string",
"specs": [
{
"email": "string",
"author": "string",
"company": "string",
"website": "string",
"memberID": "string",
"productID": "string",
"title": "string",
"content": "string",
"imageURLs": [
"string"
],
"rating": "number",
"createdAt": "number",
"updatedAt": "number",
"published": "boolean",
"isFeatured": "boolean"
}
]
}
CreateWarehouseInput: object
- tenantID:
-
Tenant ID to put this warehouse in.
- address:
-
The warehouse address.
Example
{
"tenantID": "object",
"address": {
"phones": [
"string"
],
"emails": [
"string"
],
"street": "string",
"districtCode": "string",
"postalCode": "string",
"latitude": "number",
"longitude": "number"
}
}
CreateWidgetInput: object
- brandID:
-
Brand ID to put this widget in.
- specs:
-
Specifications for creating widget.
Example
{
"brandID": "object",
"specs": [
{
"region": "string",
"order": "number",
"name": "string",
"content": "string",
"published": "boolean"
}
]
}
CreateWidgetSpec: object
- region:
-
Region of the widget.
- order:
-
Order of the widget.
- name:
-
Name of the widget.
- content:
-
Content of the widget.
- published:
-
A flag to indicate whether the widget is published or not.
Example
{
"region": "string",
"order": "number",
"name": "string",
"content": "string",
"published": "boolean"
}
DeactivateBrandInput: object
- IDs:
-
List of brand IDs to be deactivated.
Example
{
"IDs": [
"object"
]
}
DecisionMenuInput: object
- sellerId:
- brandId:
- menus:
Example
{
"sellerId": "string",
"brandId": "string",
"menus": [
{
"id": "object",
"parentsId": [
"string"
],
"title": "string",
"sequence": "number",
"root": "boolean",
"textResponse": "string",
"fileUrl": "string",
"type": "string"
}
]
}
DeleteArticlesInput: object
- articleIDs:
-
List of article IDs to be deleted.
Example
{
"articleIDs": [
"object"
]
}
DeleteDiscountsInput: object
- IDs:
-
List of discount IDs to be deleted.
Example
{
"IDs": [
"object"
]
}
DeleteNewslettersInput: object
- IDs:
-
List of newsletter IDs to be deleted.
Example
{
"IDs": [
"object"
]
}
DeleteNotificationTemplatesInput: object
- IDs:
-
List of notification template IDs to be deleted.
Example
{
"IDs": [
"object"
]
}
DeleteShippingInput: object
- IDs:
-
List of shipping IDs to be deleted.
Example
{
"IDs": [
"object"
]
}
DeleteTestimonialsInput: object
- IDs:
-
List of testimonial IDs to be deleted.
Example
{
"IDs": [
"object"
]
}
DeliveryAddress: object
- locationName:
- receiverName:
- address:
- country:
- state:
- city:
- zipCode:
- receiverPhone:
Example
{
"locationName": "string",
"receiverName": "string",
"address": "string",
"country": "string",
"state": "string",
"city": "string",
"zipCode": "string",
"receiverPhone": "string"
}
Discount: object
- brandID:
- discountID:
- channelIDs:
- discountSpec:
- title:
Example
{
"brandID": "string",
"discountID": "object",
"channelIDs": [
"string"
],
"discountSpec": {
"startDate": "number",
"endDate": "number",
"isActive": "boolean",
"referenceType": "string",
"maxItem": "number",
"rows": [
{
"referenceID": "object",
"discountType": "string",
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number"
}
]
},
"title": "string"
}
DiscountFilterInput: object
- salesChannels:
- discountType:
- referenceIDs:
- isActive:
Example
{
"salesChannels": [
"string"
],
"discountType": "string",
"referenceIDs": [
"object"
],
"isActive": "boolean"
}
DiscountRow: object
- referenceID:
- discountType:
- moneyValue:
- scalarValue:
Example
{
"referenceID": "object",
"discountType": "string",
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number"
}
DiscountSpec: object
Example
{
"startDate": "number",
"endDate": "number",
"isActive": "boolean",
"referenceType": "string",
"maxItem": "number",
"rows": [
{
"referenceID": "object",
"discountType": "string",
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number"
}
]
}
DiscountValue: object
- moneyValue:
- scalarValue:
- maximumDiscountValue:
- discountType:
- discountField:
Example
{
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number",
"maximumDiscountValue": {
"code": "string",
"value": "number"
},
"discountType": "string",
"discountField": "string"
}
DiscountValueSpec: object
- moneyValue:
-
Use this without scalar value and discount type is FIXED / ABSOLUTE
- scalarValue:
-
Use this without money value and discount type is PERCENTAGE
- maximumDiscountValue:
-
Maximum discount value when used.
- discountType:
-
The type of discount.
- discountField:
-
The field of discount.
Example
{
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number",
"maximumDiscountValue": {
"code": "string",
"value": "number"
},
"discountType": "string",
"discountField": "string"
}
DocumentsInput: object
- brandIDs:
- filter:
- sort:
- page:
Example
{
"brandIDs": [
"object"
],
"filter": {
"name": "string",
"status": "string",
"token": "string",
"signerID": "string"
},
"sort": [
{
"fieldName": "string",
"isAscending": "boolean"
}
],
"page": {
"pageNumber": "number",
"itemPerPage": "number"
}
}
EmailDestinationInput: object
- type:
-
Type for email destination input
- value:
Example
{
"type": "string",
"value": "string"
}
EmailTemplateInputV2: object
- buyer:
- isActive:
- seller:
Example
{
"buyer": {
"bccs": [
"string"
],
"ccs": [
"string"
],
"tos": [
"string"
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
},
"isActive": "boolean",
"seller": {
"bccs": [
"string"
],
"ccs": [
"string"
],
"tos": [
"string"
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
}
}
EmailTemplateSpecV2: object
- bccs:
- ccs:
- tos:
- translations:
Example
{
"bccs": [
"string"
],
"ccs": [
"string"
],
"tos": [
"string"
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
}
Enquiry: object
- ID:
- brandID:
- customFields:
- email:
- message:
- name:
- phone:
- referer:
- subject:
- createdAt:
- updatedAt:
Example
{
"ID": "string",
"brandID": "string",
"customFields": [
{
"key": "string",
"value": "string"
}
],
"email": "string",
"message": "string",
"name": "string",
"phone": "string",
"referer": "string",
"subject": "string",
"createdAt": "number",
"updatedAt": "number"
}
ExchangeAuthorizationCodeInput: object
- authorizationCode:
-
Received authorization code from OAuth.
- redirectURI:
-
URI to redirect user after authorization is successful.
- isAdmin:
-
A flag to indicate whether the user is an admin or not.
Example
{
"authorizationCode": "string",
"redirectURI": "string",
"isAdmin": "boolean"
}
ExchangePointSetting: object
- ID:
- brandID:
- brand:
- pointProvider:
- membershipLevel:
- moneyPerPoint:
- pointPerMoney:
- maximumPointsToExchangePerTransaction:
- minimumPointsToExchangePerTransaction:
- minimumMoneyToSpendPerTransaction:
- maximumMoneyToConvertPerTransaction:
- isActive:
Example
{
"ID": "object",
"brandID": "object",
"brand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {}
}
]
}
}
}
]
}
}
}
]
}
}
}
]
}
}
}
}
EximHistory: object
- ID:
- brandID:
- jobID:
- fileName:
- fileURL:
- email:
- channel:
- percentProgress:
- recordCount:
- uploadedAt:
Example
{
"ID": "object",
"brandID": "string",
"jobID": "string",
"fileName": "string",
"fileURL": "string",
"email": "string",
"channel": "string",
"percentProgress": "number",
"recordCount": "number",
"uploadedAt": "number"
}
EximHistoryFilterInput: object
- historyType:
- channel:
- uploadStartDate:
- uploadEndDate:
Example
{
"historyType": "string",
"channel": "string",
"uploadStartDate": "number",
"uploadEndDate": "number"
}
EximHistorySortInput: object
- fieldName:
- isAscending:
Example
{
"fieldName": "string",
"isAscending": "boolean"
}
ExportNewslettersInput: object
- brandID:
-
The brand that will receive exported list of newsletters.
- columnNames:
-
Newsletter field name, if empty then it will export all of the fields.
- IDs:
-
Newsletter IDs that will be exported.
- sendToEmail:
-
The email that will receive exported list of newsletters.
Example
{
"brandID": "string",
"columnNames": [
"string"
],
"IDs": [
"object"
],
"sendToEmail": "string"
}
ExportProductsInput: object
- brandID:
-
Brand ID to put the product in.
- spec:
-
Specifications for exporting product.
Example
{
"brandID": "object",
"spec": {
"columnNames": [
"string"
],
"IDs": [
"object"
],
"sendToEmail": "string"
}
}
Float: number
The Float scalar type represents signed double-precision fractional values as specified by
IEEE 754.
Example
number
GenerateAPIKeyInput: object
- accountId:
-
account that will be generated an API Key
Example
{
"accountId": "string"
}
GeneratePaymentLinkInput: object
- brandID:
-
Brand ID for the payment link.
- info:
-
Information about the payment.
- method:
-
Payment method of this payment.
- orderID:
-
Order ID for the payment link.
- providerID:
-
Provider ID of the payment.
Example
{
"brandID": "string",
"info": "string",
"method": "string",
"orderID": "string",
"providerID": "string"
}
GetSignedUrlInput: object
- uploadType:
- pathName:
- fileName:
- contentType:
- method:
Example
{
"uploadType": "string",
"pathName": "string",
"fileName": "string",
"contentType": "string",
"method": "string"
}
GetSignedlUrl: object
- uploadType:
- pathName:
- fileName:
- contentType:
- method:
Example
{
"uploadType": "string",
"pathName": "string",
"fileName": "string",
"contentType": "string",
"method": "string"
}
GoogleAnalytics: object
- universalAnalytics:
Example
{
"universalAnalytics": {
"trackingId": "string"
}
}
GoogleAnalyticsInput: object
- universalAnalytics:
Example
{
"universalAnalytics": {
"trackingId": "string"
}
}
GoogleSetting: object
- universalAnalytics:
Example
{
"universalAnalytics": {
"trackingId": "string"
}
}
GoogleSettingInput: object
- universalAnalytics:
Example
{
"universalAnalytics": {
"trackingId": "string"
}
}
GranularStatusInput: object
- specs:
-
Specifications for granular status input.
Example
{
"specs": [
{
"notes": "string",
"orderID": "string"
}
]
}
ID: object
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
object
ImportExcelInput: object
- brandID:
- fileName:
-
Name of excel file
- ignoreErrorRecord:
-
Flag to ignore error record
- moduleName:
-
The module name
- sendToEmail:
-
The email used to receive information about imported excel
Example
{
"brandID": "string",
"fileName": "string",
"ignoreErrorRecord": "boolean",
"moduleName": "string",
"sendToEmail": "string"
}
InstagramFeeds: object
- items:
- pageInfo:
Example
{
"items": [
{
"ID": "object",
"caption": "string",
"images": [
"string"
],
"thumbnail": "string"
}
],
"pageInfo": {
"hasNextPage": "boolean",
"endCursor": "string"
}
}
Int: number
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
number
InvoiceTenant: object
- ID:
- amount:
- brandID:
- creditAdj:
- invoiceDate:
- invoiceNumber:
- status:
- items:
Example
{
"ID": "object",
"amount": "number",
"brandID": "string",
"creditAdj": "number",
"invoiceDate": "string",
"invoiceNumber": "string",
"status": "string",
"items": [
{
"amount": "number",
"description": "string",
"endDate": "string",
"name": "string",
"startDate": "string"
}
]
}
Item: object
- sku:
- quantity:
- basePrice:
Example
{
"sku": "string",
"quantity": "number",
"basePrice": {
"code": "string",
"value": "number"
}
}
LineItem: object
- title:
- SKU:
- quantity:
- price:
- imageURL:
- availableStock:
- reviewStatus:
Example
{
"title": "string",
"SKU": "string",
"quantity": "number",
"price": {
"code": "string",
"value": "number"
},
"imageURL": "string",
"availableStock": "number",
"reviewStatus": "string"
}
LineItemInput: object
- title:
- SKU:
- quantity:
- price:
- imageURL:
Example
{
"title": "string",
"SKU": "string",
"quantity": "number",
"price": {
"code": "string",
"value": "number"
},
"imageURL": "string"
}
Linkspage: object
- brandId:
- backgroundColor:
- description:
- hexTextColor:
- logoImage:
- name:
- detailLinks:
Example
{
"brandId": "string",
"backgroundColor": "string",
"description": "string",
"hexTextColor": "string",
"logoImage": "string",
"name": "string",
"detailLinks": [
{
"hexBorderColor": "string",
"hexLabelColor": "string",
"iconImage": "string",
"id": "string",
"label": "string",
"ordering": "number",
"url": "string"
}
]
}
ListDecisionMenu: object
- sellerId:
- brandId:
- menus:
Example
{
"sellerId": "string",
"brandId": "string",
"menus": [
{
"id": "object",
"parentsId": [
"string"
],
"title": "string",
"sequence": "number",
"root": "boolean",
"textResponse": "string",
"fileUrl": "string",
"type": "string"
}
]
}
Lookbook: object
- ID:
- brandID:
- imageURL:
- name:
- images:
- isActive:
- slug:
Example
{
"ID": "object",
"brandID": "string",
"imageURL": "string",
"name": "string",
"images": [
{
"title": "string",
"language": "string",
"imageURL": "string"
}
],
"isActive": "boolean",
"slug": "string"
}
LookbookList: object
Example
{
"items": [
{
"ID": "object",
"brandID": "string",
"imageURL": "string",
"name": "string",
"images": [
{
"title": "string",
"language": "string",
"imageURL": "string"
}
],
"isActive": "boolean",
"slug": "string"
}
],
"pageInfo": {
"totalItems": "number",
"itemPerPage": "number",
"pageNumber": "number"
}
}
LoyaltyPoint: object
- amount:
- history:
Example
{
"amount": "number",
"history": [
{
"delta": "number",
"happenedAt": "number",
"info": "string"
}
]
}
MarketingTenant: object
- ID:
- dateCreated:
- salutation:
- firstName:
- dateOfBirth:
- email:
- alternatifEmail:
- phoneNumber:
- alternatifPhoneNumber:
- addressLine:
- postalCode:
- state:
- country:
Example
{
"ID": "object",
"dateCreated": "string",
"salutation": "string",
"firstName": "string",
"dateOfBirth": "string",
"email": "string",
"alternatifEmail": "string",
"phoneNumber": "string",
"alternatifPhoneNumber": "string",
"addressLine": "string",
"postalCode": "string",
"state": "string",
"country": "string"
}
MarketplaceConnectionForm: object
- code:
- fullName:
- type:
- fields:
- url:
Example
{
"code": "string",
"fullName": "string",
"type": "string",
"fields": [
{
"name": "string",
"label": "string",
"type": "string"
}
],
"url": "string"
}
Member: object
- accountID:
- ID:
- addresses:
- email:
- firstName:
- lastName:
- gender:
- phone:
- dateOfBirth:
- createdAt:
- updatedAt:
- level:
- loyaltyPoint:
- membership:
- membershipModel:
- haveAccessTo:
- haveAccessToWithReason:
- orders:
-
Query order within brand.
'query' is prioritized, 'filter' is only used if 'query' is not specfied
Example
{
"accountID": "string",
"ID": "string",
"addresses": [
{
"addressLabel": "string",
"contactName": "string",
"districtCode": "string",
"location": "string",
"street": "string",
"latitude": "string",
"longitude": "string",
"postalCode": "string",
"isPrimary": "boolean",
"salesChannel": "string"
}
],
"email": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"phone": "string",
"dateOfBirth": "number",
"createdAt": "number",
"updatedAt": "number",
"level": "string",
"loyaltyPoint": {
"amount": "number",
"history": [
{
"delta": "number",
"happenedAt": "number",
"info": "string"
}
]
},
"membership": {
"point": "number",
"history": [
{
"delta": "number",
"happenedAt": "number",
"info": "string"
}
]
},
"membershipModel": {
"ID": "string",
"type": "string",
"brandID": "string",
"pointProvider": "string",
"membershipLevel": "string",
"percentageOfPointFromTotalPurchase": "number",
"discount": "number",
"isActive": "boolean",
"maximumPointToExchangePerTransaction": "number",
"minimumPointToExchangePerTransaction": "number",
"minimumMoneyToSpendPerTransaction": "number",
"maximumMoneyToConvertPerTransaction": "number",
"minimumOrder": "number"
}
}
MemberAccount: object
- firstName:
- lastName:
- email:
- phone:
- dateOfBirth:
- deliveryAddress:
Example
{
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateOfBirth": "object",
"deliveryAddress": [
{
"locationName": "string",
"receiverName": "string",
"address": "string",
"country": "string",
"state": "string",
"city": "string",
"zipCode": "string",
"receiverPhone": "string"
}
]
}
MemberAccountUpsertInput: object
- firstName:
- lastName:
- email:
- password:
- address:
- country:
- state:
- city:
- zipCode:
- phone:
- dateOfBirth:
Example
{
"firstName": "string",
"lastName": "string",
"email": "string",
"password": "string",
"address": "string",
"country": "string",
"state": "string",
"city": "string",
"zipCode": "string",
"phone": "string",
"dateOfBirth": "object"
}
MemberAccountUpsertResponse: object
- memberAccount:
- errors:
Example
{
"memberAccount": {
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateOfBirth": "object",
"deliveryAddress": [
{
"locationName": "string",
"receiverName": "string",
"address": "string",
"country": "string",
"state": "string",
"city": "string",
"zipCode": "string",
"receiverPhone": "string"
}
]
},
"errors": [
{
"field": "string",
"message": "string"
}
]
}
MemberAddress: object
- addressLabel:
- contactName:
- districtCode:
- location:
- street:
- latitude:
- longitude:
- postalCode:
- isPrimary:
- salesChannel:
Example
{
"addressLabel": "string",
"contactName": "string",
"districtCode": "string",
"location": "string",
"street": "string",
"latitude": "string",
"longitude": "string",
"postalCode": "string",
"isPrimary": "boolean",
"salesChannel": "string"
}
MemberAddressInput: object
- addressLabel:
-
Label for this address.
- contactName:
-
Contact name for this address.
- districtCode:
-
District code for this address.
- street:
-
This address' street name.
- latitude:
-
Address' latitude.
- longitude:
-
Address' longitude.
- postalCode:
-
Postal code for this address.
- isPrimary:
-
A flag to indicate whether this is the primary address or not.
- salesChannel:
-
Sales channel for this address
Example
{
"addressLabel": "string",
"contactName": "string",
"districtCode": "string",
"street": "string",
"latitude": "string",
"longitude": "string",
"postalCode": "string",
"isPrimary": "boolean",
"salesChannel": "string"
}
MemberSortInput: object
- fieldName:
-
Field name to be sorted in member sort input.
- isAscending:
Example
{
"fieldName": "string",
"isAscending": "boolean"
}
Membership: object
- point:
- history:
Example
{
"point": "number",
"history": [
{
"delta": "number",
"happenedAt": "number",
"info": "string"
}
]
}
MembershipModel: object
- ID:
- type:
- brandID:
- pointProvider:
- membershipLevel:
- percentageOfPointFromTotalPurchase:
- discount:
- isActive:
- maximumPointToExchangePerTransaction:
- minimumPointToExchangePerTransaction:
- minimumMoneyToSpendPerTransaction:
- maximumMoneyToConvertPerTransaction:
- minimumOrder:
Example
{
"ID": "string",
"type": "string",
"brandID": "string",
"pointProvider": "string",
"membershipLevel": "string",
"percentageOfPointFromTotalPurchase": "number",
"discount": "number",
"isActive": "boolean",
"maximumPointToExchangePerTransaction": "number",
"minimumPointToExchangePerTransaction": "number",
"minimumMoneyToSpendPerTransaction": "number",
"maximumMoneyToConvertPerTransaction": "number",
"minimumOrder": "number"
}
MembershipModelInput: object
- brandIDs:
- filterSpec:
- sortCriteriaSpecs:
- pageSpec:
Example
{
"brandIDs": [
"object"
],
"filterSpec": {
"provider": "string",
"membershipLevel": "string",
"type": "string",
"minimumOrder": "number"
},
"sortCriteriaSpecs": [
{
"fieldName": "string",
"isAscending": "boolean"
}
],
"pageSpec": {
"pageNumber": "number",
"itemPerPage": "number"
}
}
MessageTemplate: object
- sellerId:
- id:
- key:
- value:
- type:
- status:
- category:
- attachment:
- attachmentType:
Example
{
"sellerId": "string",
"id": "number",
"key": "string",
"value": "string",
"type": "string",
"status": "boolean",
"category": "string",
"attachment": "string",
"attachmentType": "string"
}
ModuleAction: object
- label:
- key:
- child:
Example
{
"label": "string",
"key": "string",
"child": [
{
"label": "string",
"key": "string",
"child": [
{
"label": "string",
"key": "string",
"child": [
{
"label": "string",
"key": "string",
"child": [
{
"label": "string",
"key": "string",
"child": [
{
"label": "string",
"key": "string",
"child": [
{
"label": "string",
"key": "string",
"child": [
{
"label": "string",
"key": "string",
"child": [
{
"label": "string",
"key": "string",
"child": [
{
"label": "string",
"key": "string",
"child": [
{
"label": "string",
"key": "string",
"child": [
{
"label": "string",
"key": "string",
"child": [
{
"label": "string",
"key": "string",
"child": [
{
"label": "string",
"key": "string",
"child": [
{}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
MonthlySales: object
- brandID:
- orderCount:
- productSales:
- soldQuantity:
- totalDiscount:
- totalNetRevenue:
- totalOrderAmount:
- totalShippingFee:
- yearMonth:
Example
{
"brandID": "string",
"orderCount": "number",
"productSales": [
{
"orderCount": "number",
"productName": "string",
"productSKU": "string",
"soldQuantity": "number",
"totalNetRevenue": {
"code": "string",
"value": "number"
}
}
],
"soldQuantity": "number",
"totalDiscount": {
"code": "string",
"value": "number"
},
"totalNetRevenue": {
"code": "string",
"value": "number"
},
"totalOrderAmount": {
"code": "string",
"value": "number"
},
"totalShippingFee": {
"code": "string",
"value": "number"
},
"yearMonth": "number"
}
NewMemberCoupon: object
- ID:
- couponID:
- brandID:
- brand:
- code:
- type:
- title:
- isActive:
- isValid:
- salesChannel:
- couponType:
- maximumUsageCount:
- applicableStartTimestamp:
- applicableEndTimestamp:
- discountValue:
- usages:
- validityPeriod:
- minimumPurchase:
Example
{
"ID": "string",
"couponID": "string",
"brandID": "string",
"brand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string"
}
]
}
}
}
]
}
}
}
]
}
}
}
]
}
}
}
}
NewsletterSetting: object
- brandID:
- credential:
-
Credential detail for newsletter.
- popup:
-
Popup detail for newsletter.
Example
{
"brandID": "string",
"credential": {
"apiKey": "string",
"listId": "string"
},
"popup": {
"content": "string",
"popupOnFirstVisit": "boolean"
}
}
NotificationEmailTemplate: object
- ID:
- isActive:
- destinations:
- sendOrder:
- translations:
Example
{
"ID": "string",
"isActive": "boolean",
"destinations": [
{
"type": "string",
"value": "string"
}
],
"sendOrder": "number",
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
}
NotificationEmailTemplateSpec: object
- bccs:
- ccs:
- tos:
- translations:
Example
{
"bccs": [
"string"
],
"ccs": [
"string"
],
"tos": [
"string"
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
}
NotificationEmailTemplateV2: object
- buyer:
- isActive:
- seller:
Example
{
"buyer": {
"bccs": [
"string"
],
"ccs": [
"string"
],
"tos": [
"string"
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
},
"isActive": "boolean",
"seller": {
"bccs": [
"string"
],
"ccs": [
"string"
],
"tos": [
"string"
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
}
}
NotificationEventSpecs: object
Example
{
"specs": [
{
"displayName": "string",
"event": {
"type": "string",
"version": "number"
}
}
]
}
NotificationEventTemplateSpec: object
- displayName:
- event:
Example
{
"displayName": "string",
"event": {
"type": "string",
"version": "number"
}
}
NotificationEventType: string
-
objectMEMBER_REGISTERED
-
objectORDER_CREATED
-
objectORDER_PAYMENT_REMINDER
NotificationSMSTemplate: object
- ID:
- isActive:
- destinations:
- sendOrder:
- translations:
Example
{
"ID": "string",
"isActive": "boolean",
"destinations": [
{
"phoneNumber": "string"
}
],
"sendOrder": "number",
"translations": [
{
"language": "string",
"body": "string"
}
]
}
NotificationSMSTemplateV2: object
- buyer:
- isActive:
- seller:
Example
{
"buyer": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
},
"isActive": "boolean",
"seller": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
}
}
NotificationSmsTemplateSpec: object
- targetPhoneNumbers:
- translations:
Example
{
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
}
NotificationTemplate: object
- ID:
- emailTemplates:
- whatsAppTemplates:
- SMSTemplates:
- type:
- version:
- isActive:
Example
{
"ID": "object",
"emailTemplates": [
{
"ID": "string",
"isActive": "boolean",
"destinations": [
{
"type": "string",
"value": "string"
}
],
"sendOrder": "number",
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
}
],
"whatsAppTemplates": [
{
"ID": "string",
"isActive": "boolean",
"destinations": [
{
"phoneNumber": "string"
}
],
"sendOrder": "number",
"translations": [
{
"language": "string",
"body": "string"
}
]
}
],
"SMSTemplates": [
{
"ID": "string",
"isActive": "boolean",
"destinations": [
{
"phoneNumber": "string"
}
],
"sendOrder": "number",
"translations": [
{
"language": "string",
"body": "string"
}
]
}
],
"type": "string",
"version": "string",
"isActive": "boolean"
}
NotificationTemplateFilterInput: object
- eventType:
- eventVersion:
Example
{
"eventType": "string",
"eventVersion": "number"
}
NotificationTemplateSortInput: object
- fieldName:
- isAscending:
Example
{
"fieldName": "string",
"isAscending": "boolean"
}
NotificationTemplateV2: object
- ID:
- emailTemplate:
- whatsAppTemplate:
- SMSTemplate:
- event:
Example
{
"ID": "object",
"emailTemplate": {
"buyer": {
"bccs": [
"string"
],
"ccs": [
"string"
],
"tos": [
"string"
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
},
"isActive": "boolean",
"seller": {
"bccs": [
"string"
],
"ccs": [
"string"
],
"tos": [
"string"
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
}
},
"whatsAppTemplate": {
"buyer": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
},
"isActive": "boolean",
"seller": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
}
},
"SMSTemplate": {
"buyer": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
},
"isActive": "boolean",
"seller": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{}
]
}
}
}
NotificationWhatsAppTemplate: object
- ID:
- isActive:
- destinations:
- sendOrder:
- translations:
Example
{
"ID": "string",
"isActive": "boolean",
"destinations": [
{
"phoneNumber": "string"
}
],
"sendOrder": "number",
"translations": [
{
"language": "string",
"body": "string"
}
]
}
NotificationWhatsAppTemplateV2: object
- buyer:
- isActive:
- seller:
Example
{
"buyer": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
},
"isActive": "boolean",
"seller": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
}
}
NotificationWhatsappTemplateSpec: object
- targetPhoneNumbers:
- translations:
Example
{
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
}
Option: object
- id:
- translations:
Example
{
"id": "string",
"translations": [
{
"language": "string",
"text": "string"
}
]
}
OptionInput: object
- ID:
-
ID of the option.
- translations:
-
Translations for option input.
Example
{
"ID": "object",
"translations": [
{
"language": "string",
"text": "string"
}
]
}
Order: object
- ID:
- brandID:
- channelID:
- brand:
- invoiceID:
- createdAt:
- updatedAt:
- status:
- paymentStatus:
- memberID:
- buyerNote:
- billingAddress:
- deliveryAddress:
- lineItems:
- shipping:
- payment:
- discount:
- totalCost:
- attributes:
- logs:
- paymentRecords:
- paymentLinks:
Example
{
"ID": "string",
"brandID": "object",
"channelID": "string",
"brand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string"
}
]
}
}
}
]
}
}
}
]
}
}
}
]
}
}
}
}
OrderAddress: object
- name:
- email:
- phone:
- districtCode:
- country:
- province:
- city:
- subDistrict:
- street:
- postalCode:
- formattedLocation:
Example
{
"name": "string",
"email": "string",
"phone": "string",
"districtCode": "string",
"country": "string",
"province": "string",
"city": "string",
"subDistrict": "string",
"street": "string",
"postalCode": "string",
"formattedLocation": "string"
}
OrderFilterInput: object
- channelIDs:
- memberID:
- startCreationDate:
- endCreationDate:
- shippingProviders:
- statuses:
- paymentStatus:
Example
{
"channelIDs": [
"string"
],
"memberID": "string",
"startCreationDate": "number",
"endCreationDate": "number",
"shippingProviders": [
"string"
],
"statuses": [
"string"
],
"paymentStatus": [
"string"
]
}
OrderLog: object
- orderID:
- order:
- createdDate:
- actor:
- action:
- newValue:
- notes:
Example
{
"orderID": "string",
"order": {
"ID": "string",
"brandID": "object",
"channelID": "string",
"brand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string"
}
]
}
}
}
]
}
}
}
]
}
}
}
]
}
}
}
}
}
OrderLogAction: string
-
objectACCEPTED
-
objectCANCELLED
-
objectCOMPLETED
-
objectCREATED
-
objectDELETED
-
objectUPDATED
-
objectREADY_TO_SHIP
-
objectRETURNED
-
objectSHIPPED
-
objectSTATUS_UPDATED
-
objectSET_ATTRIBUTE
-
objectSET_BILLING
-
objectSET_DELIVERY
-
objectSET_LINE_ITEM
-
objectSET_PAYMENT
-
objectSET_SHIPPING
OrderSortInput: object
- fieldName:
- isAscending:
Example
{
"fieldName": "string",
"isAscending": "boolean"
}
OrderSpecs: object
- memberID:
- invoiceID:
- channelID:
- discount:
- totalCost:
- buyerNote:
- billingAddress:
- deliveryAddress:
- lineItems:
- shipping:
- payment:
- attributes:
Example
{
"memberID": "string",
"invoiceID": "string",
"channelID": "string",
"discount": {
"code": "string",
"value": "number"
},
"totalCost": {
"code": "string",
"value": "number"
},
"buyerNote": "string",
"billingAddress": {
"name": "string",
"email": "string",
"phone": "string",
"country": "string",
"province": "string",
"city": "string",
"subDistrict": "string",
"street": "string",
"districtCode": "string",
"postalCode": "string"
},
"deliveryAddress": {
"name": "string",
"email": "string",
"phone": "string",
"country": "string",
"province": "string",
"city": "string",
"subDistrict": "string",
"street": "string",
"districtCode": "string",
"postalCode": "string"
},
"lineItems": [
{
"title": "string",
"SKU": "string",
"quantity": "number",
"price": {
"code": "string",
"value": "number"
},
"imageURL": "string"
}
],
"shipping": {
"provider": "string",
"service": "string",
"cost": {
"code": "string",
"value": "number"
},
"AWBNumber": "string"
},
"payment": {
"provider": "string"
}
}
OrderStatus: string
-
objectCREATED
-
objectACCEPTED
-
objectCANCELLED
-
objectCOMPLETED
-
objectREADY_TO_SHIP
-
objectRETURNED
-
objectSHIPPED
PagedAdminProfile: object
- items:
- pageInfo:
Example
{
"items": [
{
"ID": "object",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"passwordIsSet": "boolean",
"permission": {
"actions": [
"string"
],
"administeredBrandIDs": [
"string"
],
"allAction": "boolean"
},
"apiKey": {
"clientId": "string",
"clientSecret": "string"
},
"lastLogin": "number",
"role": "string"
}
],
"pageInfo": {
"totalItems": "number",
"itemPerPage": "number",
"pageNumber": "number"
}
}
PagedArticle: object
Example
{
"items": [
{
"ID": "string",
"articleID": "string",
"categoryID": "string",
"category": {
"categoryID": "string",
"imageURL": "string",
"translations": [
{
"language": "string",
"name": "string"
}
],
"SEOs": [
{
"language": "string",
"title": "string",
"description": "string",
"keywords": [
"string"
]
}
],
"isActive": "boolean",
"displayType": "string",
"slug": "string"
},
"slug": "string",
"descriptions": [
{
"language": "string",
"title": "string",
"content": "string"
}
],
"SEOs": [
{
"language": "string",
"title": "string",
"description": "string",
"keywords": [
"string"
]
}
],
"isActive": "boolean"
}
],
"pageInfo": {
"totalItems": "number",
"itemPerPage": "number",
"pageNumber": "number"
}
}
PagedArticleCategory: object
- items:
- pageInfo:
Example
{
"items": [
{
"categoryID": "string",
"imageURL": "string",
"translations": [
{
"language": "string",
"name": "string"
}
],
"SEOs": [
{
"language": "string",
"title": "string",
"description": "string",
"keywords": [
"string"
]
}
],
"isActive": "boolean",
"displayType": "string",
"slug": "string"
}
],
"pageInfo": {
"totalItems": "number",
"itemPerPage": "number",
"pageNumber": "number"
}
}
PagedBanner: object
Example
{
"items": [
{
"ID": "string",
"imageURL": "string",
"targetURL": "string",
"translations": [
{
"language": "string",
"title": "string",
"description": "string"
}
],
"activeStartTime": "number",
"activeEndTime": "number",
"published": "boolean",
"ordering": "number"
}
],
"pageInfo": {
"totalItems": "number",
"itemPerPage": "number",
"pageNumber": "number"
}
}
PagedBestSellingProduct: object
- items:
- pageInfo:
Example
{
"items": [
{
"brandID": "string",
"orderCount": "number",
"productName": "string",
"productSKU": "string",
"revenue": {
"code": "string",
"value": "number"
},
"soldQuantity": "number"
}
],
"pageInfo": {
"totalItems": "number",
"itemPerPage": "number",
"pageNumber": "number"
}
}
PagedBillingTenant: object
- items:
- pageInfo:
Example
{
"items": [
{
"ID": "object",
"name": "string",
"email": "string",
"phone": "string",
"balance": "string"
}
],
"pageInfo": {
"totalItems": "number",
"itemPerPage": "number",
"pageNumber": "number"
}
}
PagedBrand: object
Example
{
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string"
}
}
]
}
}
}
]
}
}
}
]
}
}
}
]
}
}
}
]
}
PagedBundle: object
-
items:
object[]
- pageInfo:
Example
{
"items": [
null
],
"pageInfo": {
"totalItems": "number",
"itemPerPage": "number",
"pageNumber": "number"
}
}
PagedCollection: object
- items:
- pageInfo:
Example
{
"items": [
{
"ID": "object",
"slug": "string",
"details": [
{
"name": "string",
"description": "string",
"language": "string"
}
],
"imageURLs": [
"string"
],
"published": "boolean",
"channelIDs": [
"object"
],
"SEOs": [
{
"title": "string",
"description": "string",
"keywords": [
"string"
],
"language": "string"
}
],
"attributes": [
{
"key": "string",
"value": "string"
}
],
"parentIDs": [
"object"
],
"aggregate": {
"totalPublishedProduct": "number"
}
}
],
"pageInfo": {
"totalItems": "number",
"itemPerPage": "number",
"pageNumber": "number"
}
}
PagedCoupon: object
-
items:
object[]
- pageInfo:
Example
{
"items": [
null
],
"pageInfo": {
"totalItems": "number",
"itemPerPage": "number",
"pageNumber": "number"
}
}
PagedDiscount: object
Example
{
"items": [
{
"brandID": "string",
"discountID": "object",
"channelIDs": [
"string"
],
"discountSpec": {
"startDate": "number",
"endDate": "number",
"isActive": "boolean",
"referenceType": "string",
"maxItem": "number",
"rows": [
{
"referenceID": "object",
"discountType": "string",
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number"
}
]
},
"title": "string"
}
],
"pageInfo": {
"totalItems": "number",
"itemPerPage": "number",
"pageNumber": "number"
}
}
PagedExchangePointSetting: object
- items:
- pageInfo:
Example
{
"items": [
{
"ID": "object",
"brandID": "object",
"brand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string"
}
]
}
}
}
]
}
}
}
]
}
}
}
]
}
}
}
}
]
}
PagedEximHistory: object
- items:
- pageInfo:
Example
{
"items": [
{
"ID": "object",
"brandID": "string",
"jobID": "string",
"fileName": "string",
"fileURL": "string",
"email": "string",
"channel": "string",
"percentProgress": "number",
"recordCount": "number",
"uploadedAt": "number"
}
],
"pageInfo": {
"totalItems": "number",
"itemPerPage": "number",
"pageNumber": "number"
}
}
PagedLookbook: object
Example
{
"items": [
{
"ID": "object",
"brandID": "string",
"imageURL": "string",
"name": "string",
"images": [
{
"title": "string",
"language": "string",
"imageURL": "string"
}
],
"isActive": "boolean",
"slug": "string"
}
],
"pageInfo": {
"totalItems": "number",
"itemPerPage": "number",
"pageNumber": "number"
}
}
PagedMarketingTenant: object
- items:
- pageInfo:
Example
{
"items": [
{
"ID": "object",
"dateCreated": "string",
"salutation": "string",
"firstName": "string",
"dateOfBirth": "string",
"email": "string",
"alternatifEmail": "string",
"phoneNumber": "string",
"alternatifPhoneNumber": "string",
"addressLine": "string",
"postalCode": "string",
"state": "string",
"country": "string"
}
],
"pageInfo": {
"totalItems": "number",
"itemPerPage": "number",
"pageNumber": "number"
}
}
PagedMember: object
Example
{
"items": [
{
"accountID": "string",
"ID": "string",
"addresses": [
{
"addressLabel": "string",
"contactName": "string",
"districtCode": "string",
"location": "string",
"street": "string",
"latitude": "string",
"longitude": "string",
"postalCode": "string",
"isPrimary": "boolean",
"salesChannel": "string"
}
],
"email": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"phone": "string",
"dateOfBirth": "number",
"createdAt": "number",
"updatedAt": "number",
"level": "string",
"loyaltyPoint": {
"amount": "number",
"history": [
{
"delta": "number",
"happenedAt": "number",
"info": "string"
}
]
},
"membership": {
"point": "number",
"history": [
{
"delta": "number",
"happenedAt": "number",
"info": "string"
}
]
},
"membershipModel": {
"ID": "string",
"type": "string",
"brandID": "string",
"pointProvider": "string",
"membershipLevel": "string",
"percentageOfPointFromTotalPurchase": "number",
"discount": "number",
"isActive": "boolean",
"maximumPointToExchangePerTransaction": "number",
"minimumPointToExchangePerTransaction": "number",
"minimumMoneyToSpendPerTransaction": "number"
}
}
]
}
PagedMonthlySales: object
- items:
- pageInfo:
Example
{
"items": [
{
"brandID": "string",
"orderCount": "number",
"productSales": [
{
"orderCount": "number",
"productName": "string",
"productSKU": "string",
"soldQuantity": "number",
"totalNetRevenue": {
"code": "string",
"value": "number"
}
}
],
"soldQuantity": "number",
"totalDiscount": {
"code": "string",
"value": "number"
},
"totalNetRevenue": {
"code": "string",
"value": "number"
},
"totalOrderAmount": {
"code": "string",
"value": "number"
},
"totalShippingFee": {
"code": "string",
"value": "number"
},
"yearMonth": "number"
}
],
"pageInfo": {
"totalItems": "number",
"itemPerPage": "number",
"pageNumber": "number"
}
}
PagedNewsletter: object
- items:
- pageInfo:
Example
{
"items": [
{
"ID": "string",
"brandID": "string",
"email": "string",
"createdAt": "number"
}
],
"pageInfo": {
"totalItems": "number",
"itemPerPage": "number",
"pageNumber": "number"
}
}
PagedNotificationHistory: object
- items:
- pageInfo:
Example
{
"items": [
{
"createdAt": "number",
"eventDisplayName": "string",
"recipient": "string",
"toCustomer": "boolean",
"sender": "string",
"sentVia": "string"
}
],
"pageInfo": {
"totalItems": "number",
"itemPerPage": "number",
"pageNumber": "number"
}
}
PagedNotificationTemplate: object
- items:
- pageInfo:
Example
{
"items": [
{
"ID": "object",
"emailTemplates": [
{
"ID": "string",
"isActive": "boolean",
"destinations": [
{
"type": "string",
"value": "string"
}
],
"sendOrder": "number",
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
}
],
"whatsAppTemplates": [
{
"ID": "string",
"isActive": "boolean",
"destinations": [
{
"phoneNumber": "string"
}
],
"sendOrder": "number",
"translations": [
{
"language": "string",
"body": "string"
}
]
}
],
"SMSTemplates": [
{
"ID": "string",
"isActive": "boolean",
"destinations": [
{
"phoneNumber": "string"
}
],
"sendOrder": "number",
"translations": [
{
"language": "string",
"body": "string"
}
]
}
],
"type": "string",
"version": "string",
"isActive": "boolean"
}
],
"pageInfo": {
"totalItems": "number",
"itemPerPage": "number",
"pageNumber": "number"
}
}
PagedNotificationTemplateV2: object
- items:
- pageInfo:
Example
{
"items": [
{
"ID": "object",
"emailTemplate": {
"buyer": {
"bccs": [
"string"
],
"ccs": [
"string"
],
"tos": [
"string"
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
},
"isActive": "boolean",
"seller": {
"bccs": [
"string"
],
"ccs": [
"string"
],
"tos": [
"string"
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
}
},
"whatsAppTemplate": {
"buyer": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
},
"isActive": "boolean",
"seller": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
}
},
"SMSTemplate": {
"buyer": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
},
"isActive": "boolean",
"seller": {
"targetPhoneNumbers": [
"string"
],
"translations": [
null
]
}
}
}
]
}
PagedOrder: object
Example
{
"items": [
{
"ID": "string",
"brandID": "object",
"channelID": "string",
"brand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string"
}
]
}
}
}
]
}
}
}
]
}
}
}
]
}
}
}
}
]
}
PagedProduct: object
- items:
- pageInfo:
- appliedInput:
Example
{
"items": [
{
"ID": "object",
"brandID": "object",
"brand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string"
}
]
}
}
}
]
}
}
}
]
}
}
}
]
}
}
}
}
]
}
PagedProductRecommendation: object
- items:
- pageInfo:
Example
{
"items": [
{
"ID": "object",
"brandID": "object",
"brand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string"
}
]
}
}
}
]
}
}
}
]
}
}
}
]
}
}
}
}
]
}
PagedProductReview: object
- items:
- pageInfo:
- appliedFilter:
Example
{
"items": [
{
"ID": "object",
"brandID": "object",
"orderID": "object",
"orderCompletedAt": "number",
"productID": "object",
"product": {
"ID": "object",
"brandID": "object",
"brand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string"
}
}
]
}
}
}
]
}
}
}
]
}
}
}
}
}
]
}
PagedSalesByMember: object
- items:
- pageInfo:
Example
{
"items": [
{
"brandID": "string",
"email": "string",
"memberID": "string",
"orderCount": "number",
"orderDate": "number",
"totalDiscount": {
"code": "string",
"value": "number"
},
"totalOrderAmount": {
"code": "string",
"value": "number"
},
"totalShippingFee": {
"code": "string",
"value": "number"
}
}
],
"pageInfo": {
"totalItems": "number",
"itemPerPage": "number",
"pageNumber": "number"
}
}
PagedSalesChannel: object
- items:
- pageInfo:
Example
{
"items": [
{
"code": "string",
"channelAttributes": [
{
"key": "string",
"value": "string"
}
]
}
],
"pageInfo": {
"totalItems": "number",
"itemPerPage": "number",
"pageNumber": "number"
}
}
PagedShipping: object
Example
{
"items": [
{
"brandID": "object",
"ID": "object",
"provider": "string",
"services": [
{
"name": "string",
"isActive": "boolean",
"isAutoAWB": "boolean",
"useInsurance": "boolean"
}
],
"isActive": "boolean",
"brand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string"
}
}
]
}
}
}
]
}
}
}
]
}
}
}
}
]
}
PagedTestimonial: object
- items:
- pageInfo:
Example
{
"items": [
{
"ID": "string",
"brandID": "string",
"email": "string",
"author": "string",
"company": "string",
"website": "string",
"memberID": "string",
"productID": "string",
"title": "string",
"content": "string",
"imageURLs": [
"string"
],
"rating": "number",
"createdAt": "number",
"updatedAt": "number",
"published": "boolean",
"isFeatured": "boolean"
}
],
"pageInfo": {
"totalItems": "number",
"itemPerPage": "number",
"pageNumber": "number"
}
}
PagedWarehouse: object
Example
{
"items": [
{
"warehouseID": "object",
"tenantID": "object",
"ID": "object",
"address": {
"phones": [
"string"
],
"emails": [
"string"
],
"districtCode": "string",
"street": "string",
"latitude": "number",
"longitude": "number",
"postalCode": "string",
"formattedAddress": "string"
},
"isDefault": "boolean"
}
],
"page": {
"totalItems": "number",
"itemPerPage": "number",
"pageNumber": "number"
}
}
PaymentAdminConfig: object
- ID:
- providerID:
- method:
- configs:
Example
{
"ID": "string",
"providerID": "string",
"method": "string",
"configs": [
{
"name": "string",
"value": "string"
}
]
}
PaymentAdminConfigInput: object
- ID:
-
The ID of an existing admin configuration to be updated/inserted.
- providerID:
-
The payment provider ID.
- method:
-
The payment method.
- configs:
-
Configurations for the admin.
Example
{
"ID": "string",
"providerID": "string",
"method": "string",
"configs": [
{
"name": "string",
"value": "string"
}
]
}
PaymentConfirmationUpsertInput: object
- orderID:
-
The ID of an existing payment confirmation to be updated/inserted.
- transactionDate:
-
The date of the transaction.
- senderName:
-
The name of the sender.
- amount:
-
Payment amount.
- recipientBankName:
-
The recipient's bank name.
- senderEmail:
-
Sender's email.
- attachment:
-
Payment confirmation attachment.
Example
{
"orderID": "string",
"transactionDate": "number",
"senderName": "string",
"amount": "string",
"recipientBankName": "string",
"senderEmail": "string",
"attachment": "string"
}
PaymentField: object
- label:
- name:
- type:
- description:
- isRequired:
- options:
- conditionalShows:
Example
{
"label": "string",
"name": "string",
"type": "string",
"description": "string",
"isRequired": "boolean",
"options": [
"string"
],
"conditionalShows": [
{
"formFieldName": "string",
"condition": "string"
}
]
}
PaymentGateway: object
-
paymentProvider:
object
- paymentAdminConfig:
Example
{
"paymentAdminConfig": {
"ID": "string",
"providerID": "string",
"method": "string",
"configs": [
{
"name": "string",
"value": "string"
}
]
}
}
PaymentInput: object
- provider:
- service:
- fee:
- uniqueCode:
Example
{
"provider": "string",
"service": "string",
"fee": {
"code": "string",
"value": "number"
},
"uniqueCode": "number"
}
PaymentMethod: object
- name:
- merchantID:
- clientKey:
- serverKey:
- acquiringBank:
- payPalAccount:
- specs:
-
Specifications for a payment method.
Example
{
"name": "string",
"merchantID": "string",
"clientKey": "string",
"serverKey": "string",
"acquiringBank": "string",
"payPalAccount": "string",
"specs": [
{
"method": "string",
"isActive": "boolean",
"chargeFeeToCustomer": "boolean",
"expiryHour": "number"
}
]
}
PaymentMethodInput: object
- name:
-
Name of the payment method.
- merchantID:
-
Merchant ID of the payment method.
- clientKey:
-
Client key of the payment method.
- serverKey:
-
Server key of the payment method.
- acquiringBank:
-
Acquiring bank of the payment method.
- payPalAccount:
-
Paypal account of the payment method.
- specs:
-
Specifications for payment method.
Example
{
"name": "string",
"merchantID": "string",
"clientKey": "string",
"serverKey": "string",
"acquiringBank": "string",
"payPalAccount": "string",
"specs": [
{
"method": "string",
"isActive": "boolean",
"chargeFeeToCustomer": "boolean",
"expiryHour": "number"
}
]
}
PaymentMethods: object
- paymentMethods:
-
Collection of payment methods for payment methods.
Example
{
"paymentMethods": [
{
"name": "string",
"merchantID": "string",
"clientKey": "string",
"serverKey": "string",
"acquiringBank": "string",
"payPalAccount": "string",
"specs": [
{
"method": "string",
"isActive": "boolean",
"chargeFeeToCustomer": "boolean",
"expiryHour": "number"
}
]
}
]
}
PaymentMethodsInput: object
- paymentMethods:
-
A list of payment methods.
Example
{
"paymentMethods": [
{
"name": "string",
"merchantID": "string",
"clientKey": "string",
"serverKey": "string",
"acquiringBank": "string",
"payPalAccount": "string",
"specs": [
{
"method": "string",
"isActive": "boolean",
"chargeFeeToCustomer": "boolean",
"expiryHour": "number"
}
]
}
]
}
PaymentRecord: object
- brandID:
- orderID:
- provider:
- method:
- status:
- info:
Example
{
"brandID": "string",
"orderID": "string",
"provider": "string",
"method": "string",
"status": "string",
"info": [
{
"amount": "string",
"attachment": "string",
"orderID": "string",
"recipientBankName": "string",
"senderEmail": "string",
"senderName": "string",
"transactionDate": "number"
}
]
}
PaymentRecordInfo: object
- amount:
- attachment:
- orderID:
- recipientBankName:
- senderEmail:
- senderName:
- transactionDate:
Example
{
"amount": "string",
"attachment": "string",
"orderID": "string",
"recipientBankName": "string",
"senderEmail": "string",
"senderName": "string",
"transactionDate": "number"
}
PaymentSpecInput: object
- method:
-
The payment's method.
- isActive:
-
A flag to indicate whether this payment is active or not.
- chargeFeeToCustomer:
-
A flag to charge fee to customer or not.
- expiryHour:
-
A number representing when this payment is expired.
Example
{
"method": "string",
"isActive": "boolean",
"chargeFeeToCustomer": "boolean",
"expiryHour": "number"
}
PlaceOrder: object
- email:
- name:
- mobilePhone:
- address:
- city:
- postalCode:
- selectedShippingMethod:
- selectedPaymentMethod:
- couponCode:
Example
{
"email": "string",
"name": "string",
"mobilePhone": "number",
"address": "string",
"city": "string",
"postalCode": "number",
"selectedShippingMethod": "string",
"selectedPaymentMethod": "string",
"couponCode": "string"
}
Product: object
- ID:
- brandID:
- brand:
- relatedProductIDs:
- slug:
- published:
- imageURLs:
- details:
- condition:
- volume:
- weight:
- SEOs:
- attributes:
- channelAttributes:
- relatedProducts:
- tagKeys:
- collectionIDs:
- stocks:
- variants:
- legacyVariants:
- channels:
- promotions:
- collections:
- schedulePublishAt:
- scheduleOpenOrderAt:
- scheduleCloseOrderAt:
- extension:
- site:
- syncStatus:
Example
{
"ID": "object",
"brandID": "object",
"brand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {}
}
]
}
}
}
]
}
}
}
]
}
}
}
]
}
}
}
}
ProductAttribute: object
- sortIndex:
- translations:
Example
{
"sortIndex": "number",
"translations": [
{
"key": "string",
"value": "string",
"language": "string"
}
]
}
ProductCoupon: object
- ID:
- couponID:
- brandID:
- brand:
- code:
- type:
- title:
- isActive:
- isValid:
- salesChannel:
- couponType:
- maximumUsageCount:
- applicableStartTimestamp:
- applicableEndTimestamp:
- discountValue:
- usages:
- applicableSKUs:
- isMemberOnly:
- allowedMemberLevels:
- minimumPurchase:
Example
{
"ID": "string",
"couponID": "string",
"brandID": "string",
"brand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string"
}
]
}
}
}
]
}
}
}
]
}
}
}
]
}
}
}
}
ProductCustomFilter: object
- name:
-
Filter name.
- isActive:
-
Whether filter is currently active.
- type:
-
Type of filter.
- variantSpecs:
-
Filter variant specs.
- tagSpec:
-
Filter tag spec.
- priceSpec:
-
Filter price spec.
Example
{
"name": "string",
"isActive": "boolean",
"type": "string",
"variantSpecs": [
{
"key": "string",
"translations": [
{
"language": "string",
"text": "string"
}
],
"options": [
{
"attributes": [
{
"key": "string",
"value": "string"
}
],
"isActive": "boolean",
"translations": [
{
"language": "string",
"text": "string"
}
],
"value": "string"
}
]
}
],
"tagSpec": {
"options": [
{
"key": "string",
"translations": [
{
"language": "string",
"text": "string"
}
]
}
]
},
"priceSpec": {
"options": [
{
"min": "number",
"max": "number"
}
]
}
}
ProductCustomFilterInput: object
- name:
-
Filter name.
- isActive:
-
Whether filter is currently active.
- type:
-
Type of filter.
- variantSpecs:
-
Filter variant specs. Required if type is VARIANT.
- tagSpec:
-
Filter tag spec. Required if type is TAG.
- priceSpec:
-
Filter price spec. Required if type is PRICE.
Example
{
"name": "string",
"isActive": "boolean",
"type": "string",
"variantSpecs": [
{
"key": "string",
"translations": [
{
"language": "string",
"text": "string"
}
],
"options": [
{
"value": "string",
"translations": [
{
"language": "string",
"text": "string"
}
]
}
]
}
],
"tagSpec": {
"options": [
{
"key": "string",
"translations": [
{
"language": "string",
"text": "string"
}
]
}
]
},
"priceSpec": {
"options": [
{
"min": "number",
"max": "number"
}
]
}
}
ProductCustomFilterPrice: object
- options:
-
Price filter options.
Example
{
"options": [
{
"min": "number",
"max": "number"
}
]
}
ProductCustomFilterPriceInput: object
- options:
-
Price filter options.
Example
{
"options": [
{
"min": "number",
"max": "number"
}
]
}
ProductCustomFilterTag: object
- options:
-
Tag filter options.
Example
{
"options": [
{
"key": "string",
"translations": [
{
"language": "string",
"text": "string"
}
]
}
]
}
ProductCustomFilterTagInput: object
- options:
-
Tag filter options.
Example
{
"options": [
{
"key": "string",
"translations": [
{
"language": "string",
"text": "string"
}
]
}
]
}
ProductCustomFilterTagOption: object
- key:
-
Tag key.
- translations:
-
Tag filter option translations.
Example
{
"key": "string",
"translations": [
{
"language": "string",
"text": "string"
}
]
}
ProductCustomFilterTagOptionInput: object
- key:
-
Tag key.
- translations:
-
Tag filter option translations.
Example
{
"key": "string",
"translations": [
{
"language": "string",
"text": "string"
}
]
}
ProductCustomFilterVariant: object
- key:
-
Variant option key.
- translations:
-
Variant filter translations.
- options:
-
Variant filter options.
Example
{
"key": "string",
"translations": [
{
"language": "string",
"text": "string"
}
],
"options": [
{
"attributes": [
{
"key": "string",
"value": "string"
}
],
"isActive": "boolean",
"translations": [
{
"language": "string",
"text": "string"
}
],
"value": "string"
}
]
}
ProductCustomFilterVariantInput: object
- key:
-
Variant option key.
- translations:
-
Variant filter translations.
- options:
-
Variant filter options.
Example
{
"key": "string",
"translations": [
{
"language": "string",
"text": "string"
}
],
"options": [
{
"value": "string",
"translations": [
{
"language": "string",
"text": "string"
}
]
}
]
}
ProductCustomFilterVariantOption: object
- attributes:
-
Variant option attributes.
- isActive:
-
Whether option is active.
- translations:
-
Variant filter option translations.
- value:
-
Variant option value.
Example
{
"attributes": [
{
"key": "string",
"value": "string"
}
],
"isActive": "boolean",
"translations": [
{
"language": "string",
"text": "string"
}
],
"value": "string"
}
ProductCustomFilterVariantOptionInput: object
- value:
-
Variant option value.
- translations:
-
Variant filter option translations.
Example
{
"value": "string",
"translations": [
{
"language": "string",
"text": "string"
}
]
}
ProductCustomSort: object
- aToZAscending:
-
Whether to activate sort by product name ascending.
- aToZDescending:
-
Whether to activate sort by product name descending.
- priceAscending:
-
Whether to activate sort by product price ascending.
- priceDescending:
-
Whether to activate sort by product price descending.
- createdAtDescending:
-
Whether to activate sort by newest product.
Example
{
"aToZAscending": "boolean",
"aToZDescending": "boolean",
"priceAscending": "boolean",
"priceDescending": "boolean",
"createdAtDescending": "boolean"
}
ProductCustomSortInput: object
- aToZAscending:
-
Whether to activate sort by product name ascending.
- aToZDescending:
-
Whether to activate sort by product name descending.
- priceAscending:
-
Whether to activate sort by product price ascending.
- priceDescending:
-
Whether to activate sort by product price descending.
- createdAtDescending:
-
Whether to activate sort by newest product.
Example
{
"aToZAscending": "boolean",
"aToZDescending": "boolean",
"priceAscending": "boolean",
"priceDescending": "boolean",
"createdAtDescending": "boolean"
}
ProductExtension: object
- productID:
- crossSellProductIDs:
- crossSellProducts:
- upsellProductIDs:
- upsellProducts:
- discountRecommendationEnabled:
- ratingSummary:
- reviewsCount:
Example
{
"productID": "object",
"crossSellProductIDs": [
"string"
],
"crossSellProducts": [
{
"ID": "object",
"brandID": "object",
"brand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{}
]
}
}
}
]
}
}
}
]
}
}
}
]
}
}
}
}
]
}
ProductExtensionInput: object
- crossSellProductIDs:
-
cross sell product IDs for the product's extension.
- upsellProductIDs:
-
upsell product IDs for the product's extension.
- discountRecommendationEnabled:
-
discount recommendation enabled for the product's extension.
Example
{
"crossSellProductIDs": [
"string"
],
"upsellProductIDs": [
"string"
],
"discountRecommendationEnabled": "boolean"
}
ProductFilter: object
- channelID:
- channelIDs:
- minimumPrice:
- maximumPrice:
- maximumStock:
- minimumStock:
- currencyCode:
- published:
- tagName:
-
deprecated
- tagNames:
- collectionSlugs:
-
deprecated
- openOrder:
- openOrderScheduled:
- partiallyOutOfStock:
- variantOptionSpecs:
Example
{
"channelID": "string",
"channelIDs": [
"string"
],
"minimumPrice": "number",
"maximumPrice": "number",
"maximumStock": "number",
"minimumStock": "number",
"currencyCode": "string",
"published": "boolean",
"tagName": "string",
"tagNames": [
"string"
],
"collectionSlugs": [
"string"
],
"openOrder": "boolean",
"openOrderScheduled": "boolean",
"partiallyOutOfStock": "boolean",
"variantOptionSpecs": [
{
"optionKey": "string",
"optionValue": "string"
}
]
}
ProductFilterAndSort: object
- filters:
-
Custom filters.
- sorts:
-
Custom sorts.
Example
{
"filters": [
{
"name": "string",
"isActive": "boolean",
"type": "string",
"variantSpecs": [
{
"key": "string",
"translations": [
{
"language": "string",
"text": "string"
}
],
"options": [
{
"attributes": [
{
"key": "string",
"value": "string"
}
],
"isActive": "boolean",
"translations": [
{
"language": "string",
"text": "string"
}
],
"value": "string"
}
]
}
],
"tagSpec": {
"options": [
{
"key": "string",
"translations": [
{
"language": "string",
"text": "string"
}
]
}
]
},
"priceSpec": {
"options": [
{
"min": "number",
"max": "number"
}
]
}
}
],
"sorts": {
"aToZAscending": "boolean",
"aToZDescending": "boolean",
"priceAscending": "boolean",
"priceDescending": "boolean",
"createdAtDescending": "boolean"
}
}
ProductFilterAndSortInput: object
- filters:
-
Custom filters.
- sorts:
-
Custom sorts.
Example
{
"filters": [
{
"name": "string",
"isActive": "boolean",
"type": "string",
"variantSpecs": [
{
"key": "string",
"translations": [
{
"language": "string",
"text": "string"
}
],
"options": [
{
"value": "string",
"translations": [
{
"language": "string",
"text": "string"
}
]
}
]
}
],
"tagSpec": {
"options": [
{
"key": "string",
"translations": [
{
"language": "string",
"text": "string"
}
]
}
]
},
"priceSpec": {
"options": [
{
"min": "number",
"max": "number"
}
]
}
}
],
"sorts": {
"aToZAscending": "boolean",
"aToZDescending": "boolean",
"priceAscending": "boolean",
"priceDescending": "boolean",
"createdAtDescending": "boolean"
}
}
ProductFilterInput: object
- channelID:
- channelIDs:
- minimumPrice:
- maximumPrice:
- maximumStock:
- minimumStock:
- currencyCode:
- published:
- tagName:
-
deprecated
- tagNames:
- collectionSlugs:
-
deprecated
- openOrder:
- openOrderScheduled:
- partiallyOutOfStock:
- variantOptionSpecs:
Example
{
"channelID": "string",
"channelIDs": [
"string"
],
"minimumPrice": "number",
"maximumPrice": "number",
"maximumStock": "number",
"minimumStock": "number",
"currencyCode": "string",
"published": "boolean",
"tagName": "string",
"tagNames": [
"string"
],
"collectionSlugs": [
"string"
],
"openOrder": "boolean",
"openOrderScheduled": "boolean",
"partiallyOutOfStock": "boolean",
"variantOptionSpecs": [
{
"optionKey": "string",
"optionValue": "string"
}
]
}
ProductInfo: object
Example
{
"product": {
"ID": "object",
"brandID": "object",
"brand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string"
}
]
}
}
}
]
}
}
}
]
}
}
}
]
}
}
}
}
}
ProductInfoInput: object
- ID:
- price:
- quantity:
Example
{
"ID": "string",
"price": {
"code": "string",
"value": "number"
},
"quantity": "number"
}
ProductOption: object
- options:
-
Options for a product.
Example
{
"options": [
{
"key": {
"ID": "object",
"translations": [
{
"language": "string",
"text": "string"
}
],
"isDefault": "boolean"
},
"values": [
{
"ID": "object",
"translations": [
{
"language": "string",
"text": "string"
}
],
"attributes": [
{
"key": "string",
"value": "string"
}
],
"isActive": "boolean"
}
]
}
]
}
ProductOptionInput: object
- options:
-
The product's options.
Example
{
"options": [
{
"key": {
"ID": "object",
"translations": [
{
"language": "string",
"text": "string"
}
],
"isDefault": "boolean"
},
"values": [
{
"ID": "object",
"translations": [
{
"language": "string",
"text": "string"
}
],
"attributes": [
{
"key": "string",
"value": "string"
}
],
"isActive": "boolean"
}
]
}
]
}
ProductOptionKey: object
- ID:
- translations:
-
Translations for a product option key.
- isDefault:
-
Whether this is default option.
Example
{
"ID": "object",
"translations": [
{
"language": "string",
"text": "string"
}
],
"isDefault": "boolean"
}
ProductOptionKeyInput: object
- ID:
-
The ID of product option key.
- translations:
-
Translations for product option key.
- isDefault:
-
Whether this is default option. This eventually will be marked as required, but for now marked as optional for compatibility.
Example
{
"ID": "object",
"translations": [
{
"language": "string",
"text": "string"
}
],
"isDefault": "boolean"
}
ProductOptionSpec: object
- key:
-
Key for a product option specification.
- values:
-
Values for a product option specification.
Example
{
"key": {
"ID": "object",
"translations": [
{
"language": "string",
"text": "string"
}
],
"isDefault": "boolean"
},
"values": [
{
"ID": "object",
"translations": [
{
"language": "string",
"text": "string"
}
],
"attributes": [
{
"key": "string",
"value": "string"
}
],
"isActive": "boolean"
}
]
}
ProductOptionSpecInput: object
- key:
-
Key for product option.
- values:
-
Values for product option.
Example
{
"key": {
"ID": "object",
"translations": [
{
"language": "string",
"text": "string"
}
],
"isDefault": "boolean"
},
"values": [
{
"ID": "object",
"translations": [
{
"language": "string",
"text": "string"
}
],
"attributes": [
{
"key": "string",
"value": "string"
}
],
"isActive": "boolean"
}
]
}
ProductOptionValue: object
- ID:
- translations:
-
Translations for a product option value.
- attributes:
- isActive:
Example
{
"ID": "object",
"translations": [
{
"language": "string",
"text": "string"
}
],
"attributes": [
{
"key": "string",
"value": "string"
}
],
"isActive": "boolean"
}
ProductOptionValueInput: object
- ID:
-
The ID of product option value.
- translations:
-
Translations for product option value.
- attributes:
- isActive:
Example
{
"ID": "object",
"translations": [
{
"language": "string",
"text": "string"
}
],
"attributes": [
{
"key": "string",
"value": "string"
}
],
"isActive": "boolean"
}
ProductPromotion: object
- promotionID:
- promotionTitle:
- promotionType:
- channelIDs:
- startDate:
- endDate:
- moneyValue:
- scalarValue:
- isActive:
- discountType:
Example
{
"promotionID": "object",
"promotionTitle": "string",
"promotionType": "string",
"channelIDs": [
"object"
],
"startDate": "number",
"endDate": "number",
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number",
"isActive": "boolean",
"discountType": "string"
}
ProductRecommendationFilter: object
- productIDs:
- types:
Example
{
"productIDs": [
"string"
],
"types": [
"string"
]
}
ProductReview: object
- ID:
-
Review ID
- brandID:
-
Brand ID belongs to the review
- orderID:
-
Order ID belongs to the review
- orderCompletedAt:
-
Time when order completed
- productID:
-
Reviewed product id
- product:
-
Reviewed Product
- rating:
-
Rating in the review
- review:
-
Review's content
- imageURLs:
-
Review's image(s)
- videoURLs:
-
Review's video(s)
- reviewerName:
-
Reviewer's name
- reviewerEmail:
-
Reviewer's email
- customerID:
-
Customer ID
- createdByAdmin:
-
Flag that identidy whether the review created by admin or not
- submittedAt:
-
Time when the review submitted
- status:
-
Review status
Example
{
"ID": "object",
"brandID": "object",
"orderID": "object",
"orderCompletedAt": "number",
"productID": "object",
"product": {
"ID": "object",
"brandID": "object",
"brand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {}
}
}
]
}
}
}
]
}
}
}
]
}
}
}
}
}
ProductReviewFilter: object
- brandIDs:
- customerIDs:
- status:
- productIDs:
- orderIDs:
- createdByAdmin:
- rating:
- maxSubmittedAt:
- minSubmittedAt:
- skus:
Example
{
"brandIDs": [
"string"
],
"customerIDs": [
"string"
],
"status": [
"string"
],
"productIDs": [
"string"
],
"orderIDs": [
"string"
],
"createdByAdmin": "boolean",
"rating": "number",
"maxSubmittedAt": "number",
"minSubmittedAt": "number",
"skus": [
"string"
]
}
ProductReviewFilterInput: object
- brandIDs:
- customerIDs:
- status:
- productIDs:
- orderIDs:
- createdByAdmin:
- rating:
- maxSubmittedAt:
- minSubmittedAt:
- skus:
Example
{
"brandIDs": [
"string"
],
"customerIDs": [
"string"
],
"status": [
"string"
],
"productIDs": [
"string"
],
"orderIDs": [
"string"
],
"createdByAdmin": "boolean",
"rating": "number",
"maxSubmittedAt": "number",
"minSubmittedAt": "number",
"skus": [
"string"
]
}
ProductReviewSortInput: object
- fieldName:
- isAscending:
Example
{
"fieldName": "string",
"isAscending": "boolean"
}
ProductSort: object
- fieldName:
- isAscending:
Example
{
"fieldName": "string",
"isAscending": "boolean"
}
ProductSortInput: object
- fieldName:
- isAscending:
Example
{
"fieldName": "string",
"isAscending": "boolean"
}
ProductTag: object
- key:
- translations:
Example
{
"key": "string",
"translations": [
{
"language": "string",
"text": "string"
}
]
}
ProductVariant: object
- product:
- channelIDs:
- options:
- basePrices:
- salePrices:
- attributes:
- channelAttributes:
- imageURLs:
- SKU:
- details:
- stock:
- stocks:
- discounts:
Example
{
"product": {
"ID": "object",
"brandID": "object",
"brand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string"
}
]
}
}
}
]
}
}
}
]
}
}
}
]
}
}
}
}
}
ProductVariantOption: object
- key:
- name:
- options:
Example
{
"key": "string",
"name": [
{
"language": "string",
"text": "string"
}
],
"options": [
{
"id": "string",
"translations": [
{
"language": "string",
"text": "string"
}
]
}
]
}
ProductVariantOptionInput: object
- key:
-
Key for product's variant option.
- values:
-
Values for product's variant option.
Example
{
"key": {
"ID": "object",
"translations": [
{
"language": "string",
"text": "string"
}
]
},
"values": {
"ID": "object",
"translations": [
{
"language": "string",
"text": "string"
}
]
}
}
ProductVolume: object
- length:
- height:
- width:
- unit:
Example
{
"length": "number",
"height": "number",
"width": "number",
"unit": "string"
}
ProfileAddress: object
- addressLabel:
- contactName:
- districtCode:
- street:
- latitude:
- longitude:
- postalCode:
- isPrimary:
- salesChannel:
Example
{
"addressLabel": "string",
"contactName": "string",
"districtCode": "string",
"street": "string",
"latitude": "string",
"longitude": "string",
"postalCode": "string",
"isPrimary": "boolean",
"salesChannel": "string"
}
PromotionFilterInput: object
- endDate:
- startDate:
- type:
Example
{
"endDate": "object",
"startDate": "object",
"type": "string"
}
PublishTestimonialsInput: object
- IDs:
-
List of testimonial IDs to be published
Example
{
"IDs": [
"object"
]
}
PushNotificationInput: object
- enabled:
- oneSignal:
Example
{
"enabled": "boolean",
"oneSignal": {
"appID": "string",
"appKey": "string"
}
}
RawProductVariant: object
- channelIDs:
- options:
- basePrices:
- salePrices:
- attributes:
- channelAttributes:
- imageURLs:
- SKU:
Example
{
"channelIDs": [
"string"
],
"options": [
{
"variant": {
"product": {
"ID": "object",
"brandID": "object",
"brand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
null
]
}
}
}
]
}
}
}
]
}
}
}
]
}
}
}
}
}
}
]
}
ReorderTestimonialsInput: object
- IDs:
-
List of testimonial IDs to be reordered.
Example
{
"IDs": [
"object"
]
}
Sales: object
- channelID:
- variants:
- syncStatus:
Example
{
"channelID": "string",
"variants": [
{
"product": {
"ID": "object",
"brandID": "object",
"brand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string"
}
]
}
}
}
]
}
}
}
]
}
}
}
]
}
}
}
}
}
]
}
SalesByMember: object
- brandID:
- email:
- memberID:
- orderCount:
- orderDate:
- totalDiscount:
- totalOrderAmount:
- totalShippingFee:
Example
{
"brandID": "string",
"email": "string",
"memberID": "string",
"orderCount": "number",
"orderDate": "number",
"totalDiscount": {
"code": "string",
"value": "number"
},
"totalOrderAmount": {
"code": "string",
"value": "number"
},
"totalShippingFee": {
"code": "string",
"value": "number"
}
}
SalesChannel: object
- code:
- channelAttributes:
Example
{
"code": "string",
"channelAttributes": [
{
"key": "string",
"value": "string"
}
]
}
SalesItemDetail: object
- variant:
- stock:
- buffer:
- price:
- salePrice:
Example
{
"variant": {
"SKU": "object",
"optionValue": [
{
"key": "object",
"value": "string"
}
],
"stock": "number",
"attributes": [
{
"sortIndex": "number",
"translations": [
{
"key": "object",
"value": "string",
"language": "string"
}
]
}
],
"channelAttributes": [
{
"channelID": "object",
"key": "object",
"value": "string"
}
],
"images": [
"string"
]
},
"stock": "number",
"buffer": "number",
"price": {
"currencyCode": "string",
"amount": "number"
},
"salePrice": {
"currencyCode": "string",
"amount": "number"
}
}
SaveCartByMemberIDReq: object
- billingAddress:
-
The billing address of this cart.
- brandID:
-
Brand ID of this cart.
- channelID:
-
The channel ID of this store.
- memberLevel:
-
(Deprecated) The membership level of this member.
- membershipId:
-
The membershipId of this member.
- couponIDs:
-
Coupon IDs used in this cart.
- deliveryAddress:
-
The delivery address of this cart.
- lineItems:
-
The line items in this cart.
- memberID:
-
Member ID of this cart.
- payment:
-
Payment for this cart.
- shipping:
-
Shipping for this cart.
- cartID:
-
Cart ID of old cart.
- removeCoupons:
-
deprecated flag
- isCouponRemoved:
-
flag for remove coupons.
- isLineItemsRemoved:
-
flag for delete lineItems.
Example
{
"billingAddress": {
"districtCode": "string",
"email": "string",
"name": "string",
"phone": "string",
"postalCode": "string",
"street": "string",
"longLat": "string"
},
"brandID": "string",
"channelID": "string",
"memberLevel": "string",
"membershipId": "string",
"couponIDs": [
"string"
],
"deliveryAddress": {
"districtCode": "string",
"email": "string",
"name": "string",
"phone": "string",
"postalCode": "string",
"street": "string",
"longLat": "string"
},
"lineItems": [
{
"imageURL": "string",
"price": {
"code": "string",
"value": "number"
},
"quantity": "number",
"SKU": "string",
"title": "string"
}
],
"memberID": "string",
"payment": {
"fee": {
"code": "string",
"value": "number"
},
"provider": "string",
"service": "string",
"uniqueCode": "number"
},
"shipping": {
"awbNumber": "string",
"cost": {
"code": "string",
"value": "number"
},
"provider": "string",
"service": "string"
},
"cartID": "string",
"removeCoupons": "boolean",
"isCouponRemoved": "boolean",
"isLineItemsRemoved": "boolean"
}
SaveCartReq: object
- billingAddress:
-
The billing address of this cart.
- brandID:
-
The brand ID of this cart.
- cartID:
-
The ID of an existing cart to be updated/inserted. Omit this to generate a new cart
- channelID:
-
The channel ID of this store.
- couponIDs:
-
Coupons IDs used in this cart.
- deliveryAddress:
-
Delivery address for this cart.
- lineItems:
-
This line items in this cart.
- payment:
-
Payment for this cart.
- shipping:
-
Shipping for this cart.
- removeCoupons:
-
deprecated flag
- isCouponRemoved:
-
flag for remove coupons.
- isLineItemsRemoved:
-
flag for delete lineItems.
Example
{
"billingAddress": {
"districtCode": "string",
"email": "string",
"name": "string",
"phone": "string",
"postalCode": "string",
"street": "string",
"longLat": "string"
},
"brandID": "string",
"cartID": "string",
"channelID": "string",
"couponIDs": [
"string"
],
"deliveryAddress": {
"districtCode": "string",
"email": "string",
"name": "string",
"phone": "string",
"postalCode": "string",
"street": "string",
"longLat": "string"
},
"lineItems": [
{
"imageURL": "string",
"price": {
"code": "string",
"value": "number"
},
"quantity": "number",
"SKU": "string",
"title": "string"
}
],
"payment": {
"fee": {
"code": "string",
"value": "number"
},
"provider": "string",
"service": "string",
"uniqueCode": "number"
},
"shipping": {
"awbNumber": "string",
"cost": {
"code": "string",
"value": "number"
},
"provider": "string",
"service": "string"
},
"removeCoupons": "boolean",
"isCouponRemoved": "boolean",
"isLineItemsRemoved": "boolean"
}
SetAdminActions: object
- specs:
Example
{
"specs": [
{
"accountID": "string",
"actions": [
"string"
],
"brandIDs": [
"string"
],
"allAction": "boolean"
}
]
}
SetArticleDescriptionsInput: object
- brandID:
-
Brand ID of the afftected article.
- articleID:
-
The ID of the affected article.
- descriptions:
-
Input for article description to be set.
Example
{
"brandID": "object",
"articleID": "object",
"descriptions": [
{
"language": "string",
"title": "string",
"content": "string"
}
]
}
SetArticleSEOsInput: object
- brandID:
-
Brand ID of the affected article.
- articleID:
-
The ID of the affected article.
- SEOs:
-
The new search engine optimations input to be set.
Example
{
"brandID": "object",
"articleID": "object",
"SEOs": [
{
"language": "string",
"title": "string",
"description": "string",
"keywords": [
"string"
]
}
]
}
SetCouponsAsActiveInput: object
- IDs:
-
List of coupon IDs to be activated.
Example
{
"IDs": [
"object"
]
}
SetCouponsAsInactiveInput: object
- IDs:
-
List of coupon IDs to be set as inactive.
Example
{
"IDs": [
"object"
]
}
SetDeliveryAddressSpec: object
- districtCode:
-
District code for this delivery address.
- email:
-
Email for this delivery address.
- name:
-
Name for this delivery address.
- phone:
-
Phone number for this delivery address.
- postalCode:
-
Postal code for this delivery address.
- street:
-
Street name for this delivery address.
- longLat:
-
Longitud and latitude combined for this delivery address.
Example
{
"districtCode": "string",
"email": "string",
"name": "string",
"phone": "string",
"postalCode": "string",
"street": "string",
"longLat": "string"
}
SetDiscountsAsActiveInput: object
- IDs:
-
List of discount IDs to be set as active.
Example
{
"IDs": [
"object"
]
}
SetDiscountsAsInactiveInput: object
- IDs:
-
List of discount IDs to be set as inactive.
Example
{
"IDs": [
"object"
]
}
SetDiscountsRowsInput: object
- discountID:
-
The ID of the affected discount.
- rows:
-
Input for setting discount rows.
Example
{
"discountID": "object",
"rows": [
{
"referenceID": "object",
"discountType": "string",
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number"
}
]
}
SetExchangePointSettingInput: object
- specs:
-
Specifications for setting exchange point setting.
Example
{
"specs": [
{
"ID": "object",
"brandID": "string",
"pointProvider": "string",
"membershipLevel": "string",
"moneyPerPoint": "number",
"pointPerMoney": "number",
"maximumPointsToExchangePerTransaction": "number",
"minimumPointsToExchangePerTransaction": "number",
"minimumMoneyToSpendPerTransaction": "number",
"maximumMoneyToConvertPerTransaction": "number",
"isActive": "boolean"
}
]
}
SetExchangePointSettingSpecInput: object
- ID:
-
The ID of an exchange point setting to be updated/inserted. Omit this to create a new loyalty point setting.
- brandID:
-
Brand ID to put this setting in.
- pointProvider:
-
Provider of the loyalty point. e.g: 'SRCL' for 'sirclo'
- membershipLevel:
-
Membership level for exchanging points.
- moneyPerPoint:
-
Money per point ratio.
- pointPerMoney:
-
Point per money ratio.
- maximumPointsToExchangePerTransaction:
-
Maximum points that can be used in one transaction.
- minimumPointsToExchangePerTransaction:
-
Minimum points that can be used in one transaction.
- minimumMoneyToSpendPerTransaction:
-
Minimum amount of money to spend to exchange points in one transaction.
- maximumMoneyToConvertPerTransaction:
-
Maximum amount of money to spend to exchange points in one transaction.
- isActive:
-
A flag to indicate whether the setting is active of not.
Example
{
"ID": "object",
"brandID": "string",
"pointProvider": "string",
"membershipLevel": "string",
"moneyPerPoint": "number",
"pointPerMoney": "number",
"maximumPointsToExchangePerTransaction": "number",
"minimumPointsToExchangePerTransaction": "number",
"minimumMoneyToSpendPerTransaction": "number",
"maximumMoneyToConvertPerTransaction": "number",
"isActive": "boolean"
}
SetMemberLoyaltyPointInput: object
- specs:
-
Specifications for setting member loyalty point.
Example
{
"specs": [
{
"brandID": "object",
"memberID": "object",
"value": "number",
"pointProvider": "string",
"info": "string"
}
]
}
SetMemberLoyaltyPointSpecInput: object
- brandID:
-
Brand ID of the affected member
- memberID:
-
The ID of the affected member.
- value:
-
The value of loyalty point(s) to be set.
- pointProvider:
-
The provider of the loyalty points.
- info:
-
Information about the loyalty points.
Example
{
"brandID": "object",
"memberID": "object",
"value": "number",
"pointProvider": "string",
"info": "string"
}
SetMembershipModelInput: object
- specs:
Example
{
"specs": [
{
"ID": "string",
"type": "string",
"brandID": "string",
"pointProvider": "string",
"membershipLevel": "string",
"percentageOfPointFromTotalPurchase": "number",
"discount": "number",
"isActive": "boolean",
"moneyPerPoint": "number",
"pointPerMoney": "number",
"maximumPointsToExchangePerTransaction": "number",
"minimumPointsToExchangePerTransaction": "number",
"minimumMoneyToSpendPerTransaction": "number",
"maximumMoneyToConvertPerTransaction": "number",
"minimumOrder": "number"
}
]
}
SetMembershipModelSpecInput: object
- ID:
- type:
- brandID:
- pointProvider:
- membershipLevel:
- percentageOfPointFromTotalPurchase:
- discount:
- isActive:
- moneyPerPoint:
- pointPerMoney:
- maximumPointsToExchangePerTransaction:
- minimumPointsToExchangePerTransaction:
- minimumMoneyToSpendPerTransaction:
- maximumMoneyToConvertPerTransaction:
- minimumOrder:
Example
{
"ID": "string",
"type": "string",
"brandID": "string",
"pointProvider": "string",
"membershipLevel": "string",
"percentageOfPointFromTotalPurchase": "number",
"discount": "number",
"isActive": "boolean",
"moneyPerPoint": "number",
"pointPerMoney": "number",
"maximumPointsToExchangePerTransaction": "number",
"minimumPointsToExchangePerTransaction": "number",
"minimumMoneyToSpendPerTransaction": "number",
"maximumMoneyToConvertPerTransaction": "number",
"minimumOrder": "number"
}
SetMembershipPointInput: object
- specs:
Example
{
"specs": [
{
"brandID": "object",
"memberID": "object",
"value": "number",
"pointProvider": "string",
"info": "string"
}
]
}
SetOrderAttributesInput: object
- orderID:
-
The ID of the affected order.
- attributes:
-
Specifications for the order's attributes.
Example
{
"orderID": "string",
"attributes": [
{
"key": "string",
"value": "string"
}
]
}
SetOrderBillingInput: object
- orderID:
-
The ID of the affected order.
- billingAddress:
-
Billing address for the order.
Example
{
"orderID": "string",
"billingAddress": {
"name": "string",
"email": "string",
"phone": "string",
"country": "string",
"province": "string",
"city": "string",
"subDistrict": "string",
"street": "string",
"districtCode": "string",
"postalCode": "string"
}
}
SetOrderDeliveryInput: object
- orderID:
-
The ID of the affected order.
- deliveryAddress:
-
Delivery address for the order.
- shipping:
-
Shipping for the order.
Example
{
"orderID": "string",
"deliveryAddress": {
"districtCode": "string",
"email": "string",
"name": "string",
"phone": "string",
"postalCode": "string",
"street": "string",
"longLat": "string"
},
"shipping": {
"provider": "string",
"service": "string"
}
}
SetOrderLineItemsInput: object
- orderID:
-
The ID of the affected order.
- lineItems:
-
The line items for that order.
Example
{
"orderID": "string",
"lineItems": [
{
"SKU": "string",
"quantity": "number"
}
]
}
SetOrderPaymentInput: object
- orderID:
-
The ID of the affected order.
- payment:
-
Payment for the order.
Example
{
"orderID": "string",
"payment": {
"provider": "string",
"service": "string",
"fee": {
"code": "string",
"value": "number"
},
"uniqueCode": "number"
}
}
SetOrderShippingInput: object
- orderID:
-
The ID of the affected order.
- shipping:
-
Shipping for the order.
Example
{
"orderID": "string",
"shipping": {
"AWBNumber": "string",
"provider": "string",
"service": "string"
}
}
SetPaymentAvailabilityInput: object
- brandID:
-
Brand ID of the payment.
- paymentAvailabilitySpecs:
-
Payment availability specifications for setting payment availability.
Example
{
"brandID": "string",
"paymentAvailabilitySpecs": [
{
"providerID": "string",
"isActive": "boolean"
}
]
}
SetStatusAsReadyToShipReq: object
- specs:
Example
{
"specs": [
{
"orderId": "string",
"awbNumber": "string",
"isAutoAwb": "boolean"
}
]
}
SetVariantBasePriceInput: object
- productID:
-
the ID of the affected product.
- specs:
-
Specifications for setting variant base price.
Example
{
"productID": "object",
"specs": [
{
"SKU": "object",
"basePrices": [
{
"code": "string",
"value": "number"
}
]
}
]
}
SetWarehouseAsDefaultInput: object
- warehouseID:
-
The warehouse ID to be set as default.
Example
{
"warehouseID": "object"
}
ShipmentTracking: object
- referenceId:
- trackingData:
Example
{
"referenceId": "string",
"trackingData": [
{
"number": "string",
"provider": "string",
"trackingUrl": "string",
"historyStatus": [
{
"status": "string",
"timestamp": "number"
}
],
"driverInfo": {
"name": "string",
"phoneNumber": "string",
"licenseNumber": "string"
}
}
]
}
Shipping: object
Example
{
"brandID": "object",
"ID": "object",
"provider": "string",
"services": [
{
"name": "string",
"isActive": "boolean",
"isAutoAWB": "boolean",
"useInsurance": "boolean"
}
],
"isActive": "boolean",
"brand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string"
}
}
]
}
}
}
]
}
}
}
]
}
}
}
}
ShippingCost: object
- methods:
Example
{
"methods": [
{
"provider": "string",
"service": "string",
"cost": {
"code": "string",
"value": "number"
}
}
]
}
ShippingCostEstimation: object
- methods:
Example
{
"methods": [
{
"provider": "string",
"service": "string",
"message": "string",
"isEnable": "boolean",
"cost": {
"code": "string",
"value": "number"
}
}
]
}
ShippingCoupon: object
- ID:
- couponID:
- brandID:
- brand:
- code:
- type:
- title:
- isActive:
- isValid:
- salesChannel:
- couponType:
- maximumUsageCount:
- applicableStartTimestamp:
- applicableEndTimestamp:
- discountValue:
- usages:
- allowedShippingMethods:
- isMemberOnly:
- allowedMemberLevels:
- minimumPurchase:
Example
{
"ID": "string",
"couponID": "string",
"brandID": "string",
"brand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string"
}
]
}
}
}
]
}
}
}
]
}
}
}
]
}
}
}
}
ShippingInput: object
- provider:
- service:
- cost:
- AWBNumber:
Example
{
"provider": "string",
"service": "string",
"cost": {
"code": "string",
"value": "number"
},
"AWBNumber": "string"
}
ShippingMethod: object
- provider:
- service:
- cost:
- price:
Example
{
"provider": "string",
"service": "string",
"cost": "number",
"price": {
"currencyCode": "string",
"amount": "number"
}
}
ShippingRateInput: object
- fromCode:
- fromLatlong:
- toCode:
- toLatlong:
- package:
- providerFilters:
Example
{
"fromCode": "string",
"fromLatlong": "string",
"toCode": "string",
"toLatlong": "string",
"package": {
"weight": "number",
"dimension": {
"height": "number",
"length": "number",
"width": "number"
}
},
"providerFilters": [
{
"providerName": "string",
"servicesName": [
"string"
]
}
]
}
ShippingServiceInput: object
- ID:
-
The ID of the shipping service.
- name:
-
The name of the shipping service.
- isActive:
-
A flag to indicate whether the shipping service is active or not.
- isAutoAWB:
-
A flag to indicate whether the airway bill is automatic or not.
- useInsurance:
-
A flag to indicate whether the shipping used insurance or not.
Example
{
"ID": "object",
"name": "string",
"isActive": "boolean",
"isAutoAWB": "boolean",
"useInsurance": "boolean"
}
SingleUploadFromURLInput: object
- url:
- bucket:
- uploadType:
Example
{
"url": "string",
"bucket": "string",
"uploadType": "string"
}
SingleUploadInput: object
- file:
- bucket:
- contentType:
- uploadType:
Example
{
"file": "object",
"bucket": "string",
"contentType": "string",
"uploadType": "string"
}
SiteConfig: object
- siteId:
- host:
- fqdn:
- template:
- themeSettings:
Example
{
"siteId": "object",
"host": "string",
"fqdn": "string",
"template": "string",
"themeSettings": {
"faviconURL": "string",
"backgroundURL": "string",
"twitterURL": "string",
"youtubeURL": "string",
"facebookURL": "string",
"instagramURL": "string",
"storeName": "string",
"siteTitle": "string",
"siteDescription": "string",
"logoURL": "string"
}
}
SmsTemplateInputV2: object
- buyer:
- isActive:
- seller:
Example
{
"buyer": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
},
"isActive": "boolean",
"seller": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
}
}
SmsTemplateSpecV2: object
- targetPhoneNumbers:
- translations:
Example
{
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
}
SocialMediaLinkInput: object
- twitter:
-
Twitter social media link.
- facebook:
-
Facebook social media link.
- instagram:
-
Instagram social media link.
- youtube:
-
Youtube social media link.
- tiktok:
-
Tiktok social media link.
Example
{
"twitter": "string",
"facebook": "string",
"instagram": "string",
"youtube": "string",
"tiktok": "string"
}
SocmedSetting: object
- instagramToken:
- socmedLink:
Example
{
"instagramToken": "string",
"socmedLink": {
"twitter": "string",
"facebook": "string",
"instagram": "string",
"youtube": "string",
"tiktok": "string"
}
}
SortEximHistory: string
-
objectID
-
objectEMAIL
-
objectCHANNEL
-
objectBRAND_ID
-
objectPERCENT_PROGRESS
-
objectRECORDS
-
objectUPLOAD_AT
StocksInfo: object
- warehouses:
- total:
Example
{
"warehouses": [
{
"warehouseID": "object",
"SKU": "object",
"quantity": "number"
}
],
"total": "number"
}
StoreCart: object
- billingAddress:
- brandID:
- channelID:
- discount:
- ID:
- deliveryAddress:
- lineItems:
- invalidItems:
- memberID:
- memberLevel:
- payment:
- shipping:
- totalCost:
- promo:
- totalWeight:
Example
{
"billingAddress": {
"districtCode": "string",
"email": "string",
"name": "string",
"phone": "string",
"postalCode": "string",
"street": "string",
"location": {
"country": "string",
"province": "string",
"city": "string",
"district": "string"
},
"longLat": "string"
},
"brandID": "string",
"channelID": "string",
"discount": {
"code": "string",
"value": "number"
},
"ID": "string",
"deliveryAddress": {
"districtCode": "string",
"email": "string",
"name": "string",
"phone": "string",
"postalCode": "string",
"street": "string",
"location": {
"country": "string",
"province": "string",
"city": "string",
"district": "string"
},
"longLat": "string"
},
"lineItems": [
{
"imageURL": "string",
"price": {
"code": "string",
"value": "number"
},
"quantity": "number",
"SKU": "string",
"title": "string",
"availableStock": "number",
"ignoreStock": "boolean",
"errorMessage": "string",
"discount": {
"code": "string",
"value": "number"
},
"slug": "string",
"salePrice": {
"code": "string"
}
}
]
}
String: string
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
SubmitProductReviewByCustomerInput: object
- specs:
-
Specifications for submitting product review.
Example
{
"specs": [
{
"ID": "object",
"brandID": "object",
"productID": "object",
"rating": "number",
"review": "string",
"imageURLs": [
"string"
],
"videoURLs": [
"string"
],
"reviewerName": "string",
"reviewerEmail": "string",
"orderID": "string"
}
]
}
SubmitProductReviewByCustomerSpec: object
- ID:
-
Review ID
- brandID:
-
Brand ID for the product review
- productID:
-
Product ID for the review
- rating:
-
Rating in the review
- review:
-
Review's content
- imageURLs:
-
Review's image(s)
- videoURLs:
-
Review's video(s)
- reviewerName:
-
Reviewer's name
- reviewerEmail:
-
Reviewer's email
- orderID:
-
Order ID for the review
Example
{
"ID": "object",
"brandID": "object",
"productID": "object",
"rating": "number",
"review": "string",
"imageURLs": [
"string"
],
"videoURLs": [
"string"
],
"reviewerName": "string",
"reviewerEmail": "string",
"orderID": "string"
}
Subscription: object
- notification:
- message:
- chatQueue:
- profileUpdateStatus:
- cartID:
- buyer:
- adminNotification:
- cart:
Example
{
"notification": {
"key": "string",
"value": "string",
"ID": "string",
"buyer": "string",
"seller": "string"
},
"message": {
"to": "string",
"from": "string",
"timestamp": "string",
"buyer_name": "string",
"message": "string",
"id": "object",
"message_id": "object",
"gql_id": "object",
"type": "string",
"status": "string",
"context_id": "string",
"caption": "string",
"meta": [
{
"gql_id": "string",
"key": "string",
"value": "string"
}
],
"channel": "string"
},
"chatQueue": {
"action": "string",
"buyerId": "string",
"channel": "string",
"sellerId": "string",
"queueCount": "number",
"userId": "string"
},
"profileUpdateStatus": {
"errorMessage": "string",
"action": "string"
},
"cartID": {
"sellerId": "string",
"buyerId": "string",
"cartId": "string"
},
"buyer": {
"id": "object",
"name": "string",
"channel": "string",
"isRead": "boolean",
"lastMessage": "string",
"lastAlert": "string",
"timestamp": "number",
"type": "string",
"lastMessageId": "number",
"isArchived": "boolean"
}
}
Tenant: object
- ID:
- name:
- language:
- currencyCode:
- brands:
-
Query all brands within tenant
- orders:
-
Query order within tenant.
"'query' is prioritized, 'filter' is only used if 'query' is not specfied"
- products:
-
Query products within brands related to specified tenant.
'query' is prioritized, 'filter' is only used if 'query' is not specfied
- warehouses:
-
Query warehouses for tenant
- productExcelResult:
-
Field to fetch result file from exportProductExcel
- orderExcelResult:
-
Field to fetch result file from exportOrderExcel
- exchangePointSetting:
-
Query loyalty point settings.
'query' is prioritized, 'filter' is only used if 'query' is not specfied
- admins:
-
List of admins of the tenant
Example
{
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string"
}
]
}
}
}
]
}
}
}
]
}
}
}
]
}
}
}
]
}
}
Testimonial: object
- ID:
- brandID:
- email:
- author:
- company:
- website:
- memberID:
- productID:
- title:
- content:
- imageURLs:
- rating:
- createdAt:
- updatedAt:
- published:
- isFeatured:
Example
{
"ID": "string",
"brandID": "string",
"email": "string",
"author": "string",
"company": "string",
"website": "string",
"memberID": "string",
"productID": "string",
"title": "string",
"content": "string",
"imageURLs": [
"string"
],
"rating": "number",
"createdAt": "number",
"updatedAt": "number",
"published": "boolean",
"isFeatured": "boolean"
}
ThemeSettings: object
- faviconURL:
- backgroundURL:
- twitterURL:
- youtubeURL:
- facebookURL:
- instagramURL:
- storeName:
- siteTitle:
- siteDescription:
- logoURL:
Example
{
"faviconURL": "string",
"backgroundURL": "string",
"twitterURL": "string",
"youtubeURL": "string",
"facebookURL": "string",
"instagramURL": "string",
"storeName": "string",
"siteTitle": "string",
"siteDescription": "string",
"logoURL": "string"
}
Timestamp: object
The javascript Date as integer. Type represents date and time as number of milliseconds from start of UNIX epoch.
Example
object
TrackingData: object
- number:
- provider:
- trackingUrl:
- historyStatus:
- driverInfo:
Example
{
"number": "string",
"provider": "string",
"trackingUrl": "string",
"historyStatus": [
{
"status": "string",
"timestamp": "number"
}
],
"driverInfo": {
"name": "string",
"phoneNumber": "string",
"licenseNumber": "string"
}
}
Transaction: object
Example
{
"ID": "object",
"order": {
"ID": "string",
"brandID": "object",
"channelID": "string",
"brand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string"
}
]
}
}
}
]
}
}
}
]
}
}
}
]
}
}
}
}
}
TranslatableAttributeInput: object
- sortIndex:
-
Sort index of product's translatable attribute.
- translations:
-
Translations for translatable attribute.
Example
{
"sortIndex": "number",
"translations": [
{
"key": "string",
"value": "string",
"language": "string"
}
]
}
TranslatableSEOInput: object
- title:
-
Title for the translatable search engine optimation.
- description:
-
Description for the SEO.
- keywords:
-
Keywords for the SEO.
- language:
-
Language of the SEO. Should be a code and capitalized (e.g: 'ID' / 'EN').
Example
{
"title": "string",
"description": "string",
"keywords": [
"string"
],
"language": "string"
}
UnlinkGoogleMerchantAccountInput: object
- brandID:
-
The ID of the brand.
Example
{
"brandID": "object"
}
UnpublishTestimonialsInput: object
- IDs:
-
List of testimonial IDs to be unpublished.
Example
{
"IDs": [
"object"
]
}
UpdateAdminInput: object
- spec:
-
List of spec of admin to be updated
Example
{
"spec": [
{
"accountID": "string",
"adminSpec": {
"info": {
"email": "string",
"phone": "string",
"name": "string",
"tenantID": "string",
"brandIDs": [
"string"
],
"allBrand": "boolean"
},
"permission": {
"actions": [
"string"
],
"allAction": "boolean"
}
}
}
]
}
UpdateBusinessHoursInput: object
- sellerID:
- specs:
Example
{
"sellerID": "object",
"specs": [
{
"day": "number",
"openAt": "string",
"closeAt": "string",
"isOpen": "boolean"
}
]
}
UpdateOrderStatusParam: object
- orderID:
- status:
- messages:
- awb:
Example
{
"orderID": "string",
"status": "string",
"messages": "string",
"awb": "string"
}
UpdateProductReviewStatusInput: object
- specs:
-
Specifications for updating product review status
Example
{
"specs": [
{
"ID": "object",
"brandID": "object",
"status": "string"
}
]
}
UpdateProductReviewStatusSpec: object
- ID:
- brandID:
-
Brand ID for the product review
- status:
-
Product review's status
Example
{
"ID": "object",
"brandID": "object",
"status": "string"
}
UpdateProductStockAndPriceInput: object
- brandID:
-
Brand ID to put this product in.
- specs:
-
Specifications for updating product stock and price.
Example
{
"brandID": "object",
"specs": [
{
"productID": "string",
"basePrices": [
{
"code": "string",
"value": "number"
}
],
"currentStock": "number",
"stock": "number",
"ignoreCurrentStock": "boolean",
"ignoreStock": "boolean",
"warehouseID": "string",
"SKU": "string"
}
]
}
UpdateProductStockAndPriceResultSpec: object
- productID:
-
Updated product ID information.
- SKU:
-
Updated SKU information
- updatePriceError:
-
Error in price that occured when executing the mutation.
- updateStockError:
-
Error in stock that occured when executing the mutation.
- warehouseID:
-
Updated warehouse ID information.
Example
{
"productID": "string",
"SKU": "string",
"updatePriceError": "string",
"updateStockError": "string",
"warehouseID": "string"
}
UpdateProductStockAndPriceSpecInput: object
- productID:
-
product ID that will be updated,
- basePrices:
-
Base prices for updating product.
- currentStock:
-
current sku stock
- stock:
- ignoreCurrentStock:
-
ignore current stock.
set to 'true' to check the current stock in inventory and add / subtract based on 'stock' field
set to 'false' to set current stock as defined in 'stock' field
- ignoreStock:
-
ignore stock
set to 'true' to make stock always available set to 'false' then the stock depend on the quantity of product
- warehouseID:
-
specific warehouse for product to be upserted
- SKU:
Example
{
"productID": "string",
"basePrices": [
{
"code": "string",
"value": "number"
}
],
"currentStock": "number",
"stock": "number",
"ignoreCurrentStock": "boolean",
"ignoreStock": "boolean",
"warehouseID": "string",
"SKU": "string"
}
UploadType: string
-
objectACCOUNT
-
objectARTICLE_CATEGORY
-
objectARTICLE
-
objectBANNER
-
objectBRAND
-
objectBLOG
-
objectCOLLECTION
-
objectLINKSPAGE
-
objectLOOKBOOK
-
objectLOOKBOOK_IMAGE
-
objectORDER
-
objectPAYMENT
-
objectPAYMENT_CONFIRMATION
-
objectPRODUCT
-
objectPRODUCT_VARIANT
-
objectPROMOTION
-
objectTENANT
-
objectTESTIMONIAL
-
objectTEXT_EDITOR_IMAGE
-
objectSETTING
-
objectREVIEW
UpsertAdminInput: object
- accountID:
-
Account ID of the admin to be upserted.
- spec:
-
Specification for admin upsert.
Example
{
"accountID": "string",
"spec": {
"tenantID": "string",
"basicInfo": {
"email": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"phone": "string",
"dateOfBirth": "number"
},
"addresses": [
{
"addressLabel": "string",
"contactName": "string",
"districtCode": "string",
"street": "string",
"latitude": "string",
"longitude": "string",
"postalCode": "string",
"isPrimary": "boolean"
}
]
}
}
UpsertAdminSpec: object
- tenantID:
-
Assigned tenant ID of this admin.
- basicInfo:
-
Basic Information about the admin.
- addresses:
-
Address of this admin.
Example
{
"tenantID": "string",
"basicInfo": {
"email": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"phone": "string",
"dateOfBirth": "number"
},
"addresses": [
{
"addressLabel": "string",
"contactName": "string",
"districtCode": "string",
"street": "string",
"latitude": "string",
"longitude": "string",
"postalCode": "string",
"isPrimary": "boolean"
}
]
}
UpsertAnalyticsInput: object
- brandID:
-
Brand ID to put this Analytics in.
Example
{
"brandID": "object"
}
UpsertAnalyticsSettingInput: object
- brandId:
-
Brand ID to put this Analytics in.
- facebookSetting:
- googleSetting:
Example
{
"brandId": "object",
"facebookSetting": {
"pixelId": "string",
"catalogId": "string",
"accessToken": "string"
},
"googleSetting": {
"universalAnalytics": {
"trackingId": "string"
}
}
}
UpsertArticleCategoriesInput: object
- brandID:
-
Upsert article categories in which brand ID?
- specs:
-
Specifications for updating/inserting article categories.
Example
{
"brandID": "object",
"specs": [
{
"ID": "object",
"imageURL": "string",
"translations": [
{
"language": "string",
"name": "string"
}
],
"isActive": "boolean",
"SEOs": [
{
"language": "string",
"title": "string",
"description": "string",
"keywords": [
"string"
]
}
],
"displayType": "string",
"slug": "string"
}
]
}
UpsertArticleCategoriesSpec: object
- ID:
-
The ID of an existing article category to be updated/inserted. Omit this to create new article category
- imageURL:
-
Image URL to be rendered in this article category.
- translations:
-
Article category's translations.
- isActive:
-
A flag to indicate whether the article category is active or not.
- SEOs:
-
Article category's search engine optimations.
- displayType:
-
Article category's display type.
- slug:
-
Article category's slug.
Example
{
"ID": "object",
"imageURL": "string",
"translations": [
{
"language": "string",
"name": "string"
}
],
"isActive": "boolean",
"SEOs": [
{
"language": "string",
"title": "string",
"description": "string",
"keywords": [
"string"
]
}
],
"displayType": "string",
"slug": "string"
}
UpsertArticlesInput: object
- brandID:
-
Brand ID to put this article in.
- specs:
-
Specifications for articles upsert.
Example
{
"brandID": "object",
"specs": [
{
"ID": "object",
"categoryID": "object",
"slug": "string",
"descriptions": [
{
"language": "string",
"title": "string",
"content": "string"
}
],
"SEOs": [
{
"language": "string",
"title": "string",
"description": "string",
"keywords": [
"string"
]
}
],
"isActive": "boolean"
}
]
}
UpsertArticlesSpec: object
- ID:
-
The ID of an existing article to be updated/inserted. Omit this to create a new article
- categoryID:
-
Category ID to put this article in.
- slug:
-
Slug for this article.
- descriptions:
-
Descriptions for this article.
- SEOs:
-
Article's search engine optimations.
- isActive:
-
A flag to indicate whether the article is active or not.
Example
{
"ID": "object",
"categoryID": "object",
"slug": "string",
"descriptions": [
{
"language": "string",
"title": "string",
"content": "string"
}
],
"SEOs": [
{
"language": "string",
"title": "string",
"description": "string",
"keywords": [
"string"
]
}
],
"isActive": "boolean"
}
UpsertBirthdayCouponsInput: object
- brandID:
-
Brand ID to put this birthday coupon in.
- specs:
-
Specifications for birthday coupons upsert.
Example
{
"brandID": "object",
"specs": [
{
"ID": "object",
"code": "string",
"title": "string",
"isActive": "boolean",
"salesChannel": "string",
"discountValue": {
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number",
"maximumDiscountValue": {
"code": "string",
"value": "number"
},
"discountType": "string",
"discountField": "string"
},
"validityPeriod": "number",
"minimumPurchase": {
"code": "string",
"value": "number"
}
}
]
}
UpsertBirthdayCouponsSpec: object
- ID:
-
The ID of a birthday coupon to be updated/inserted. Omit this to create a new coupon.
- code:
-
The code of this birthday coupon.
- title:
-
The title of this birthday coupon.
- isActive:
-
A flag to indicate whether the birthday coupon is active or not.
- salesChannel:
-
The marketplace to use this birthday coupon.
- discountValue:
-
Specifications for discount value when upserting birthday coupons.
- validityPeriod:
-
A value to set the validity period of the birthday coupon.
- minimumPurchase:
-
Minimum purchase when using birthday coupon.
Example
{
"ID": "object",
"code": "string",
"title": "string",
"isActive": "boolean",
"salesChannel": "string",
"discountValue": {
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number",
"maximumDiscountValue": {
"code": "string",
"value": "number"
},
"discountType": "string",
"discountField": "string"
},
"validityPeriod": "number",
"minimumPurchase": {
"code": "string",
"value": "number"
}
}
UpsertBrandInput: object
- brandID:
-
Brand ID to be upserted.
- tenantID:
-
Tenant ID to put this brand in.
- name:
-
Name of this brand.
- logoURL:
-
URL of this brand's logo.
- isActive:
-
A flag to indicate whether this brand is active or not.
Example
{
"brandID": "string",
"tenantID": "string",
"name": "string",
"logoURL": "string",
"isActive": "boolean"
}
UpsertBrandMembershipSettingsInput: object
- specs:
Example
{
"specs": [
{
"brandID": "object",
"freePointForNewMember": "boolean",
"ignorePointExpiry": "boolean",
"mainMembershipModel": "string",
"minimumPointToExchange": "number",
"pointForNewMember": "number",
"usePointForDiscount": "boolean"
}
]
}
UpsertBrandSettingSpecInput: object
- brandID:
- freePointForNewMember:
- ignorePointExpiry:
- mainMembershipModel:
- minimumPointToExchange:
- pointForNewMember:
- usePointForDiscount:
Example
{
"brandID": "object",
"freePointForNewMember": "boolean",
"ignorePointExpiry": "boolean",
"mainMembershipModel": "string",
"minimumPointToExchange": "number",
"pointForNewMember": "number",
"usePointForDiscount": "boolean"
}
UpsertBuyMinAmountGetFreeItemsBundleInput: object
- brandID:
-
Brand ID to put this bundle in.
- bundles:
-
Specifications for bundle upsert.
Example
{
"brandID": "object",
"bundles": [
{
"ID": "string",
"title": "string",
"startTime": "number",
"endTime": "number",
"isActive": "boolean",
"priority": "number",
"minAmountToBuy": {
"code": "string",
"value": "number"
},
"eligibleProductIDs": [
"string"
],
"bundledProducts": [
{
"ID": "string",
"price": {
"code": "string",
"value": "number"
},
"quantity": "number"
}
]
}
]
}
UpsertBuyMinQuantityGetFreeItemsBundleInput: object
- brandID:
-
Brand ID to put this bundle in.
- bundles:
-
Specifications for bundle upsert.
Example
{
"brandID": "object",
"bundles": [
{
"ID": "string",
"title": "string",
"startTime": "number",
"endTime": "number",
"isActive": "boolean",
"priority": "number",
"minQuantityToBuy": "number",
"eligibleProductIDs": [
"string"
],
"bundledProducts": [
{
"ID": "string",
"price": {
"code": "string",
"value": "number"
},
"quantity": "number"
}
]
}
]
}
UpsertBuyNItemBundleInput: object
- brandID:
-
Brand ID to put this bundle in.
- bundles:
-
Specifications for bundle upsert.
Example
{
"brandID": "object",
"bundles": [
{
"ID": "string",
"title": "string",
"startTime": "number",
"endTime": "number",
"isActive": "boolean",
"priority": "number",
"numOfItemToBuy": "number",
"eligibleProductIDs": [
"string"
],
"fixedPrice": {
"code": "string",
"value": "number"
}
}
]
}
UpsertCartCouponsInput: object
- brandID:
-
Brand ID to put this cart coupon in.
- specs:
-
Specifications for upserting cart coupons.
Example
{
"brandID": "object",
"specs": [
{
"ID": "object",
"code": "string",
"title": "string",
"isActive": "boolean",
"salesChannel": "string",
"discountValue": {
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number",
"maximumDiscountValue": {
"code": "string",
"value": "number"
},
"discountType": "string",
"discountField": "string"
},
"maximumUsageCount": "number",
"applicableStartTimestamp": "number",
"applicableEndTimestamp": "number",
"isMemberOnly": "boolean",
"allowedMemberLevels": [
"string"
],
"minimumPurchase": {
"code": "string",
"value": "number"
}
}
]
}
UpsertCartCouponsSpec: object
- ID:
-
The ID of a cart coupon to be updated/inserted. Omit this to create a new coupon.
- code:
-
The code of this cart coupon.
- title:
-
The title of this cart coupon.
- isActive:
-
A flag to indicate whether this cart coupon is active or not.
- salesChannel:
-
The sales channel of the coupon.
- discountValue:
-
Discount value for upserting cart coupons.
- maximumUsageCount:
-
Maximum usage when using the cart coupon.
- applicableStartTimestamp:
-
A timestamp to indicate when this cart coupon is starts to be applicable.
- applicableEndTimestamp:
-
A timestamp to indicate when this cart coupon cannot be applied anymore.
- isMemberOnly:
-
A flag to indicate whether this coupon is limited to member only or not.
- allowedMemberLevels:
-
Allowed member levels to use this cart coupon.
- minimumPurchase:
-
Minimum purchase when using cart coupons.
Example
{
"ID": "object",
"code": "string",
"title": "string",
"isActive": "boolean",
"salesChannel": "string",
"discountValue": {
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number",
"maximumDiscountValue": {
"code": "string",
"value": "number"
},
"discountType": "string",
"discountField": "string"
},
"maximumUsageCount": "number",
"applicableStartTimestamp": "number",
"applicableEndTimestamp": "number",
"isMemberOnly": "boolean",
"allowedMemberLevels": [
"string"
],
"minimumPurchase": {
"code": "string",
"value": "number"
}
}
UpsertChatRoomAttributesInput: object
- sellerId:
- buyerId:
- attributes:
Example
{
"sellerId": "string",
"buyerId": "string",
"attributes": [
{
"key": "string",
"value": "string"
}
]
}
UpsertCouponSpec: object
- ID:
-
The ID of a coupon to be updated/inserted. Omit this to create a new coupon.
- code:
-
The code of the coupon.
- title:
-
The title of the coupon.
- isActive:
-
A flag to indicate whether the coupon is active or not.
- salesChannel:
-
The sales channel of the coupon.
- discountValue:
-
Specifications for discount value when upserting coupons.
Example
{
"ID": "object",
"code": "string",
"title": "string",
"isActive": "boolean",
"salesChannel": "string",
"discountValue": {
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number",
"maximumDiscountValue": {
"code": "string",
"value": "number"
},
"discountType": "string",
"discountField": "string"
}
}
UpsertDiscountsInput: object
- brandID:
-
Brand ID to put this discount in.
- specs:
-
Specifications for upserting discounts.
Example
{
"brandID": "object",
"specs": [
{
"ID": "object",
"channelIDs": [
"object"
],
"title": "string",
"startDate": "number",
"endDate": "number",
"isActive": "boolean",
"referenceType": "string",
"maxItem": "number",
"rows": [
{
"referenceID": "object",
"discountType": "string",
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number"
}
]
}
]
}
UpsertDiscountsRowInput: object
- referenceID:
-
SKU of product
- discountType:
-
The type of discount. One of PERCENTAGE/FIXED/ABSOLUTE
- moneyValue:
-
The amount of money that is granted by the discount.
- scalarValue:
-
The scalar value of the discount.
Example
{
"referenceID": "object",
"discountType": "string",
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number"
}
UpsertDiscountsSpec: object
- ID:
-
The ID of a discount to be updated/inserted. Omit this to create a new discount.
- channelIDs:
-
ID of the discount channel.
- title:
-
Title of the discount.
- startDate:
-
A date to mark the start of this discount.
- endDate:
-
A date to mark the end of this discount.
- isActive:
-
A flag to indicate whether this discount is active or not.
- referenceType:
-
The type of goods that is applicable by this discount.
- maxItem:
-
Maximum amount of items when using this discount.
- rows:
-
Rows for upserting discounts.
Example
{
"ID": "object",
"channelIDs": [
"object"
],
"title": "string",
"startDate": "number",
"endDate": "number",
"isActive": "boolean",
"referenceType": "string",
"maxItem": "number",
"rows": [
{
"referenceID": "object",
"discountType": "string",
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number"
}
]
}
UpsertEmailTemplatesSpec: object
- ID:
-
Omit this to generate a new email template
- isActive:
- destinations:
-
Destinations for updating/inserting Email templates specifications.
- translations:
-
Translations for updating/inserting Email templates specifications.
- sendOrder:
Example
{
"ID": "object",
"isActive": "boolean",
"destinations": [
{
"type": "string",
"value": "string"
}
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
],
"sendOrder": "number"
}
UpsertLinkspageInput: object
- brandId:
- backgroundColor:
- description:
- hexTextColor:
- logoImage:
- name:
- detailLinks:
Example
{
"brandId": "string",
"backgroundColor": "string",
"description": "string",
"hexTextColor": "string",
"logoImage": "string",
"name": "string",
"detailLinks": [
{
"hexBorderColor": "string",
"hexLabelColor": "string",
"iconImage": "string",
"id": "string",
"label": "string",
"ordering": "number",
"url": "string"
}
]
}
UpsertMemberAddressInput: object
- accountID:
-
Account ID of the member to be upserted.
- brandID:
-
Brand ID of this member.
- address:
-
Address of this member.
Example
{
"accountID": "string",
"brandID": "string",
"address": {
"addressLabel": "string",
"contactName": "string",
"districtCode": "string",
"street": "string",
"latitude": "string",
"longitude": "string",
"postalCode": "string",
"isPrimary": "boolean",
"salesChannel": "string"
}
}
UpsertMemberInput: object
- accountID:
-
Account ID of the member to be upserted.
- spec:
-
Specification for member upsert.
Example
{
"accountID": "string",
"spec": {
"brandID": "string",
"basicInfo": {
"email": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"phone": "string",
"dateOfBirth": "number"
},
"addresses": [
{
"addressLabel": "string",
"contactName": "string",
"districtCode": "string",
"street": "string",
"latitude": "string",
"longitude": "string",
"postalCode": "string",
"isPrimary": "boolean",
"salesChannel": "string"
}
]
}
}
UpsertMemberSpec: object
- brandID:
-
Member's brand ID.
- basicInfo:
-
Basic information for member.
- addresses:
-
Address of this member.
Example
{
"brandID": "string",
"basicInfo": {
"email": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"phone": "string",
"dateOfBirth": "number"
},
"addresses": [
{
"addressLabel": "string",
"contactName": "string",
"districtCode": "string",
"street": "string",
"latitude": "string",
"longitude": "string",
"postalCode": "string",
"isPrimary": "boolean",
"salesChannel": "string"
}
]
}
UpsertMembershipInput: object
- specs:
Example
{
"specs": [
{
"ID": "object",
"memberID": "string",
"membershipModelID": "string",
"delta": "number",
"info": "string"
}
]
}
UpsertNewMemberCouponsInput: object
- brandID:
-
Brand ID to put this new member coupon in.
- specs:
-
Specifications for upserting new member coupon.
Example
{
"brandID": "object",
"specs": [
{
"ID": "object",
"code": "string",
"title": "string",
"isActive": "boolean",
"salesChannel": "string",
"discountValue": {
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number",
"maximumDiscountValue": {
"code": "string",
"value": "number"
},
"discountType": "string",
"discountField": "string"
},
"validityPeriod": "number",
"minimumPurchase": {
"code": "string",
"value": "number"
}
}
]
}
UpsertNewMemberCouponsSpec: object
- ID:
-
The ID of a new member coupon to be updated/inserted. Omit this to create a new coupon.
- code:
-
The code of the new member coupon.
- title:
-
The title of the new member coupon.
- isActive:
-
A flag to indicate whether the new member coupon is active or not.
- salesChannel:
-
The sales channel of the coupon.
- discountValue:
-
Discount value for upserting new member coupons.
- validityPeriod:
-
A number representing a period where this coupon is valid.
- minimumPurchase:
-
Minimum purchase when using the coupon.
Example
{
"ID": "object",
"code": "string",
"title": "string",
"isActive": "boolean",
"salesChannel": "string",
"discountValue": {
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number",
"maximumDiscountValue": {
"code": "string",
"value": "number"
},
"discountType": "string",
"discountField": "string"
},
"validityPeriod": "number",
"minimumPurchase": {
"code": "string",
"value": "number"
}
}
UpsertNewsletterSettingsInput: object
- brandID:
-
The ID of an existing brand to be updated/inserted.
- credential:
-
Credential detail for newsletter.
- popup:
-
Popup detail for newsletter.
Example
{
"brandID": "string",
"credential": {
"apiKey": "string",
"listId": "string"
},
"popup": {
"content": "string",
"popupOnFirstVisit": "boolean"
}
}
UpsertOrderInput: object
- brandID:
-
Brand ID to put this order in.
- specs:
-
Specifications for upserting order input.
Example
{
"brandID": "string",
"specs": [
{
"ID": "string",
"spec": {
"memberID": "string",
"invoiceID": "string",
"channelID": "string",
"discount": {
"code": "string",
"value": "number"
},
"totalCost": {
"code": "string",
"value": "number"
},
"buyerNote": "string",
"billingAddress": {
"name": "string",
"email": "string",
"phone": "string",
"country": "string",
"province": "string",
"city": "string",
"subDistrict": "string",
"street": "string",
"districtCode": "string",
"postalCode": "string"
},
"deliveryAddress": {
"name": "string",
"email": "string",
"phone": "string",
"country": "string",
"province": "string",
"city": "string",
"subDistrict": "string",
"street": "string",
"districtCode": "string",
"postalCode": "string"
},
"lineItems": [
{
"title": "string",
"SKU": "string",
"quantity": "number",
"price": {
"code": "string",
"value": "number"
},
"imageURL": "string"
}
],
"shipping": {
"provider": "string",
"service": "string",
"cost": {}
}
}
}
]
}
UpsertPaymentAdminConfigsInput: object
- brandID:
-
Brand ID of payment admin configurations.
- adminConfigs:
-
Admin configurations for upserting payment admin configurations.
Example
{
"brandID": "string",
"adminConfigs": [
{
"ID": "string",
"providerID": "string",
"method": "string",
"configs": [
{
"name": "string",
"value": "string"
}
]
}
]
}
UpsertPaymentEnumeratedAdminConfigsInput: object
- brandID:
-
Brand ID of payment admin configurations.
- adminConfigs:
-
Admin configurations for upserting payment admin configurations.
- enableNegativeBankTransferUniqueCode:
-
Enable negative unique code for bank transfers
Example
{
"brandID": "string",
"adminConfigs": [
{
"ID": "string",
"providerID": "string",
"method": "string",
"configs": [
{
"name": "string",
"value": "string"
}
]
}
],
"enableNegativeBankTransferUniqueCode": "boolean"
}
UpsertProductCouponsInput: object
- brandID:
-
Brand ID to put this product coupon in.
- specs:
-
Specifications for product coupons upserting.
Example
{
"brandID": "object",
"specs": [
{
"ID": "object",
"code": "string",
"title": "string",
"isActive": "boolean",
"salesChannel": "string",
"discountValue": {
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number",
"maximumDiscountValue": {
"code": "string",
"value": "number"
},
"discountType": "string",
"discountField": "string"
},
"maximumUsageCount": "number",
"applicableSKUs": [
"string"
],
"applicableStartTimestamp": "number",
"applicableEndTimestamp": "number",
"isMemberOnly": "boolean",
"allowedMemberLevels": [
"string"
],
"minimumPurchase": {
"code": "string",
"value": "number"
}
}
]
}
UpsertProductCouponsSpec: object
- ID:
-
The ID of a product coupon to be updated/inserted. Omit this to create a new coupon.
- code:
-
The code for this product coupon.
- title:
-
The title of this product coupon.
- isActive:
-
A flag to indicate whether the product coupon is active or not.
- salesChannel:
-
The sales channel of the product coupon.
- discountValue:
-
Discount value for upserting product coupons.
- maximumUsageCount:
-
Maximum usage when using this product coupon.
- applicableSKUs:
-
List of SKUs that can be used with this product coupon.
- applicableStartTimestamp:
-
A timestamp to indicate when this cart coupon is starts to be applicable.
- applicableEndTimestamp:
-
A timestamp to indicate when this cart coupon cannot be applied anymore.
- isMemberOnly:
-
A flag to indicate whether this coupon is limited to member only or not.
- allowedMemberLevels:
-
Allowed member levels to use this cart coupon.
- minimumPurchase:
-
Minimum purchase when using cart coupons.
Example
{
"ID": "object",
"code": "string",
"title": "string",
"isActive": "boolean",
"salesChannel": "string",
"discountValue": {
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number",
"maximumDiscountValue": {
"code": "string",
"value": "number"
},
"discountType": "string",
"discountField": "string"
},
"maximumUsageCount": "number",
"applicableSKUs": [
"string"
],
"applicableStartTimestamp": "number",
"applicableEndTimestamp": "number",
"isMemberOnly": "boolean",
"allowedMemberLevels": [
"string"
],
"minimumPurchase": {
"code": "string",
"value": "number"
}
}
UpsertProductInput: object
- brandID:
-
Brand ID to put this product in.
- specs:
-
Specifications for upserting product.
Example
{
"brandID": "object",
"specs": [
{
"details": [
{
"name": "string",
"description": "string",
"language": "string"
}
],
"volume": {
"length": "number",
"height": "number",
"width": "number",
"unit": "string"
},
"weight": {
"value": "number",
"unit": "string"
},
"imageURLs": [
"string"
],
"published": "boolean",
"variants": [
{
"SKU": "object",
"options": [
{
"key": "object",
"value": "string"
}
],
"basePrices": [
{
"code": "string",
"value": "number"
}
],
"channelIDs": [
"string"
],
"attributes": [
{
"sortIndex": "number",
"translations": [
{
"key": "string",
"value": "string",
"language": "string"
}
]
}
],
"channelAttributes": [
{
"channelID": "string",
"key": "object",
"value": "string"
}
],
"imageURLs": [
"string"
],
"stock": "number",
"warehouseID": "string",
"currentStock": "number",
"ignoreCurrentStock": "boolean",
"ignoreStock": "boolean"
}
],
"productID": "object",
"slug": "string",
"SEOs": [
null
]
}
]
}
UpsertProductReviewInput: object
- specs:
-
Specifications for upserting product review.
Example
{
"specs": [
{
"ID": "object",
"brandID": "object",
"productID": "object",
"imageURLs": [
"string"
]
}
]
}
UpsertProductSpecInput: object
- details:
-
Details of the product.
- volume:
-
Volume of the product.
- weight:
-
Weight of the product.
- imageURLs:
-
URL of the product's image.
- published:
-
A flag to indicate whether this product is published or not.
- variants:
-
Variants of the product.
- productID:
-
The ID of a product to be updated/inserted. Omit this to create new product.
- slug:
-
Sulg of the product.
- SEOs:
-
Translatable SEO for the product.
- condition:
-
Condition of the product.
- attributes:
-
The product's attributes.
- channelAttributes:
-
The product's channel attributes.
- relatedProductIds:
-
Other products that are related to this product.
- tagKeys:
-
Tags for this product.
- collectionIds:
-
List of collection IDs that have this product in them.
- schedulePublishAt:
-
Time when the product can be viewed.
- scheduleOpenOrderAt:
-
Time when the product can be ordered.
- scheduleCloseOrderAt:
-
Time when the product can't be ordered anymore.
- extension:
-
Product extension input.
Example
{
"details": [
{
"name": "string",
"description": "string",
"language": "string"
}
],
"volume": {
"length": "number",
"height": "number",
"width": "number",
"unit": "string"
},
"weight": {
"value": "number",
"unit": "string"
},
"imageURLs": [
"string"
],
"published": "boolean",
"variants": [
{
"SKU": "object",
"options": [
{
"key": "object",
"value": "string"
}
],
"basePrices": [
{
"code": "string",
"value": "number"
}
],
"channelIDs": [
"string"
],
"attributes": [
{
"sortIndex": "number",
"translations": [
{
"key": "string",
"value": "string",
"language": "string"
}
]
}
],
"channelAttributes": [
{
"channelID": "string",
"key": "object",
"value": "string"
}
],
"imageURLs": [
"string"
],
"stock": "number",
"warehouseID": "string",
"currentStock": "number",
"ignoreCurrentStock": "boolean",
"ignoreStock": "boolean"
}
],
"productID": "object",
"slug": "string",
"SEOs": [
{
"title": "string",
"description": "string"
}
]
}
UpsertSettingInput: object
- adminEmail:
-
Admin's email of the brand.
- bankAccount:
-
Bank account of the brand.
- brandID:
-
The ID of an existing brand to be updated/inserted.
- checkoutAsGuestEnabled:
-
A flag to allow or disallow checkout as guest.
- confirmPaymentMessage:
-
Set the brand confirm payment message.
- faviconURL:
-
URL of the brand favicon.
- hideFromSearchEngine:
-
A flag to indicate whether this brand can be found from search engine or not.
- newsletter:
-
The brand's newsletter.
- paymentMethods:
-
The brand's payment methods.
- productFilterAndSort:
-
The brand's custom filter and sort.
- productOption:
-
The brand's product option.
- reviewsAndRatingEnabled:
-
A flag to allow or disallow reviews and rating.
- setAsMaintenance:
-
Set the current brand status as maintenance.
- socialMediaLink:
-
The brand's social media link.
- websiteDescription:
-
The brand's website description.
- websiteTitle:
-
The brand's website title.
- defaultExchangePointSettingID:
-
The exchange point setting for this brand.
- facebookAnalytics:
- googleAnalytics:
- privyID:
- notificationCCEmail:
-
Notification default cc email
- pushNotification:
-
The push notification setting for this brand
- googleAuth:
-
The brand's Google OAuth credentials
- stockReminderEnabled:
-
Brand's stock reminder enabled flag
- noReplyEmail:
-
email address for no reply email
Example
{
"adminEmail": "string",
"bankAccount": {
"banks": [
{
"name": "string",
"accountNumber": "string",
"accountName": "string",
"isActive": "boolean"
}
]
},
"brandID": "string",
"checkoutAsGuestEnabled": "boolean",
"confirmPaymentMessage": {
"isActive": "boolean",
"message": "string"
},
"faviconURL": "string",
"hideFromSearchEngine": "boolean",
"newsletter": {
"popupOnFirstVisit": "boolean",
"content": "string"
},
"paymentMethods": {
"paymentMethods": [
{
"name": "string",
"merchantID": "string",
"clientKey": "string",
"serverKey": "string",
"acquiringBank": "string",
"payPalAccount": "string",
"specs": [
{
"method": "string",
"isActive": "boolean",
"chargeFeeToCustomer": "boolean",
"expiryHour": "number"
}
]
}
]
},
"productFilterAndSort": {
"filters": [
{
"name": "string",
"isActive": "boolean",
"type": "string",
"variantSpecs": [
{
"key": "string",
"translations": [
{
"language": "string",
"text": "string"
}
],
"options": [
{
"value": "string",
"translations": [
{
"language": "string",
"text": "string"
}
]
}
]
}
]
}
]
}
}
UpsertShippingCouponsInput: object
- brandID:
-
Brand ID to put this shipping coupons in.
- specs:
-
Specifications for upserting shipping coupons.
Example
{
"brandID": "object",
"specs": [
{
"ID": "object",
"code": "string",
"title": "string",
"isActive": "boolean",
"salesChannel": "string",
"discountValue": {
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number",
"maximumDiscountValue": {
"code": "string",
"value": "number"
},
"discountType": "string",
"discountField": "string"
},
"allowedShippingMethods": [
"string"
],
"applicableStartTimestamp": "number",
"applicableEndTimestamp": "number",
"maximumUsageCount": "number",
"isMemberOnly": "boolean",
"allowedMemberLevels": [
"string"
],
"minimumPurchase": {
"code": "string",
"value": "number"
}
}
]
}
UpsertShippingCouponsSpec: object
- ID:
-
The ID of a shipping coupon to be updated/inserted. Omit this to create a new coupon.
- code:
-
The code for this shipping coupon.
- title:
-
The title of this product coupon.
- isActive:
-
A flag to indicate whether the shipping coupon is active or not.
- salesChannel:
-
The sales channel of the shipping coupon.
- discountValue:
-
Discount value for upserting shipping coupons.
- allowedShippingMethods:
-
Allowed shipping method when using this shipping coupon.
- applicableStartTimestamp:
-
A timestamp to indicate when this cart coupon is starts to be applicable.
- applicableEndTimestamp:
-
A timestamp to indicate when this cart coupon cannot be applied anymore.
- maximumUsageCount:
-
Maximum usage when using this shipping coupon.
- isMemberOnly:
-
A flag to indicate whether this coupon is limited to member only or not.
- allowedMemberLevels:
-
Allowed member levels to use this cart coupon.
- minimumPurchase:
-
Minimum purchase for upserting shipping coupons.
Example
{
"ID": "object",
"code": "string",
"title": "string",
"isActive": "boolean",
"salesChannel": "string",
"discountValue": {
"moneyValue": {
"code": "string",
"value": "number"
},
"scalarValue": "number",
"maximumDiscountValue": {
"code": "string",
"value": "number"
},
"discountType": "string",
"discountField": "string"
},
"allowedShippingMethods": [
"string"
],
"applicableStartTimestamp": "number",
"applicableEndTimestamp": "number",
"maximumUsageCount": "number",
"isMemberOnly": "boolean",
"allowedMemberLevels": [
"string"
],
"minimumPurchase": {
"code": "string",
"value": "number"
}
}
UpsertShippingSpec: object
- ID:
-
The ID of a shipping to be updated/inserted. Omit this to create a new shipping method.
- provider:
-
The shipping's provider.
- services:
-
Services for upserting shipping specifications.
- isActive:
-
A flag to indicate whther the shipping is active or not.
Example
{
"ID": "object",
"provider": "string",
"services": [
{
"ID": "object",
"name": "string",
"isActive": "boolean",
"isAutoAWB": "boolean",
"useInsurance": "boolean"
}
],
"isActive": "boolean"
}
UpsertShippingsInput: object
- brandID:
-
Brand ID to put this shipping in.
- specs:
-
Specifications for upserting shippings.
Example
{
"brandID": "object",
"specs": [
{
"ID": "object",
"provider": "string",
"services": [
{
"ID": "object",
"name": "string",
"isActive": "boolean",
"isAutoAWB": "boolean",
"useInsurance": "boolean"
}
],
"isActive": "boolean"
}
]
}
UpsertSmsTemplatesSpec: object
- ID:
-
Omit this to generate a new sms template
- translations:
-
Translations for updating/inserting SMS templates specifications.
- destinations:
-
Destinations for updating/inserting SMS templates specifications.
- sendOrder:
Example
{
"ID": "object",
"translations": [
{
"language": "string",
"body": "string"
}
],
"destinations": [
{
"phoneNumber": "string"
}
],
"sendOrder": "number"
}
UpsertSocmedSettingInput: object
- brandID:
- instagramToken:
- socmedLink:
Example
{
"brandID": "string",
"instagramToken": "string",
"socmedLink": {
"twitter": "string",
"facebook": "string",
"instagram": "string",
"youtube": "string",
"tiktok": "string"
}
}
UpsertSpec: object
- ID:
-
The ID of an order to be updated/inserted. Omit this to create a new order.
- spec:
-
Specifications for upserting order specifications.
Example
{
"ID": "string",
"spec": {
"memberID": "string",
"invoiceID": "string",
"channelID": "string",
"discount": {
"code": "string",
"value": "number"
},
"totalCost": {
"code": "string",
"value": "number"
},
"buyerNote": "string",
"billingAddress": {
"name": "string",
"email": "string",
"phone": "string",
"country": "string",
"province": "string",
"city": "string",
"subDistrict": "string",
"street": "string",
"districtCode": "string",
"postalCode": "string"
},
"deliveryAddress": {
"name": "string",
"email": "string",
"phone": "string",
"country": "string",
"province": "string",
"city": "string",
"subDistrict": "string",
"street": "string",
"districtCode": "string",
"postalCode": "string"
},
"lineItems": [
{
"title": "string",
"SKU": "string",
"quantity": "number",
"price": {
"code": "string",
"value": "number"
},
"imageURL": "string"
}
],
"shipping": {
"provider": "string",
"service": "string",
"cost": {
"code": "string",
"value": "number"
},
"AWBNumber": "string"
}
}
}
UpsertTemplatesInput: object
- brandID:
-
Brand ID to put this template in.
- specs:
-
Specifications for upserting templates.
Example
{
"brandID": "object",
"specs": [
{
"ID": "object",
"eventType": "string",
"eventVersion": "number",
"isActive": "boolean",
"emailTemplates": [
{
"ID": "object",
"isActive": "boolean",
"destinations": [
{
"type": "string",
"value": "string"
}
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
],
"sendOrder": "number"
}
],
"smsTemplates": [
{
"ID": "object",
"translations": [
{
"language": "string",
"body": "string"
}
],
"destinations": [
{
"phoneNumber": "string"
}
],
"sendOrder": "number"
}
],
"whatsAppTemplates": [
{
"ID": "object",
"translations": [
{
"language": "string",
"body": "string"
}
],
"destinations": [
{
"phoneNumber": "string"
}
],
"sendOrder": "number"
}
]
}
]
}
UpsertTemplatesInputV2: object
- brandID:
-
Brand ID to put this template in.
- specs:
-
Specifications for upserting notificationV2 template.
Example
{
"brandID": "object",
"specs": [
{
"ID": "object",
"event": {
"type": "string",
"version": "number"
},
"emailTemplate": {
"buyer": {
"bccs": [
"string"
],
"ccs": [
"string"
],
"tos": [
"string"
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
},
"isActive": "boolean",
"seller": {
"bccs": [
"string"
],
"ccs": [
"string"
],
"tos": [
"string"
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
}
},
"smsTemplate": {
"buyer": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
},
"isActive": "boolean",
"seller": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
}
},
"whatsAppTemplate": {
"buyer": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
}
}
}
]
}
UpsertTemplatesSpec: object
- ID:
-
The ID of a template to be updated/inserted. Omit this to generate a new template.
- eventType:
-
Event type for upserting templates.
- eventVersion:
-
The version of event.
- isActive:
-
A flag to indicate whether the template is active or not.
- emailTemplates:
-
Email templates for upserting templates.
- smsTemplates:
-
SMS templates for upserting templates.
- whatsAppTemplates:
-
WhatsApp templates for upserting templates.
Example
{
"ID": "object",
"eventType": "string",
"eventVersion": "number",
"isActive": "boolean",
"emailTemplates": [
{
"ID": "object",
"isActive": "boolean",
"destinations": [
{
"type": "string",
"value": "string"
}
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
],
"sendOrder": "number"
}
],
"smsTemplates": [
{
"ID": "object",
"translations": [
{
"language": "string",
"body": "string"
}
],
"destinations": [
{
"phoneNumber": "string"
}
],
"sendOrder": "number"
}
],
"whatsAppTemplates": [
{
"ID": "object",
"translations": [
{
"language": "string",
"body": "string"
}
],
"destinations": [
{
"phoneNumber": "string"
}
],
"sendOrder": "number"
}
]
}
UpsertTemplatesSpecV2: object
- ID:
-
The ID of a template to be updated/inserted. Omit this to generate a new template.
- event:
-
Event type for upserting notificationV2 template
- emailTemplate:
-
Email template for upserting notificationV2 template.
- smsTemplate:
-
SMS template for upserting notificationV2 template.
- whatsAppTemplate:
-
WhatsApp template for upserting notificationV2 template.
Example
{
"ID": "object",
"event": {
"type": "string",
"version": "number"
},
"emailTemplate": {
"buyer": {
"bccs": [
"string"
],
"ccs": [
"string"
],
"tos": [
"string"
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
},
"isActive": "boolean",
"seller": {
"bccs": [
"string"
],
"ccs": [
"string"
],
"tos": [
"string"
],
"translations": [
{
"body": "string",
"language": "string",
"subject": "string"
}
]
}
},
"smsTemplate": {
"buyer": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
},
"isActive": "boolean",
"seller": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
}
},
"whatsAppTemplate": {
"buyer": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
},
"isActive": "boolean",
"seller": {
"targetPhoneNumbers": [
null
]
}
}
}
UpsertTestimonialSpec: object
- ID:
-
The ID of a testimony to be updated/inserted. Omit this to create a new testimonial.
- email:
-
The email of the testimony.
- author:
-
The author of the testimony.
- company:
-
The company of the testimony
- website:
-
The website of the testimony.
- memberID:
-
The member ID of the member linked to the testimony.
- productID:
-
The product ID of the product linked to the testimony.
- title:
-
The title of the testimony.
- content:
-
The content of the testimony. Minimum 20 characters needed.
- imageURLs:
-
URLs of the testimony's images.
- rating:
-
Rating in the testimony. Between 1-5.
- createdAt:
-
A number representing when this testimony is created.
- updatedAt:
-
A number representing when this testimony is updated.
- published:
-
A flag to indicate whether the testimony is published or not.
- isFeatured:
Example
{
"ID": "string",
"email": "string",
"author": "string",
"company": "string",
"website": "string",
"memberID": "string",
"productID": "string",
"title": "string",
"content": "string",
"imageURLs": [
"string"
],
"rating": "number",
"createdAt": "number",
"updatedAt": "number",
"published": "boolean",
"isFeatured": "boolean"
}
UpsertTestimonialsInput: object
- brandID:
-
Brand ID to put the testimonials in.
- specs:
-
Specifications for upserting testimonials input.
Example
{
"brandID": "string",
"specs": [
{
"ID": "string",
"email": "string",
"author": "string",
"company": "string",
"website": "string",
"memberID": "string",
"productID": "string",
"title": "string",
"content": "string",
"imageURLs": [
"string"
],
"rating": "number",
"createdAt": "number",
"updatedAt": "number",
"published": "boolean",
"isFeatured": "boolean"
}
]
}
UpsertWarehouseInput: object
- warehouseID:
-
The ID of an existing warehouse to be updated/inserted.
- tenantID:
-
Tenant ID to put the warehouse in.
- address:
-
The warehouse address.
Example
{
"warehouseID": "object",
"tenantID": "object",
"address": {
"phones": [
"string"
],
"emails": [
"string"
],
"street": "string",
"districtCode": "string",
"postalCode": "string",
"latitude": "number",
"longitude": "number"
}
}
UpsertWhatsAppTemplatesSpec: object
- ID:
-
Omit this to generate a new whatsapp template
- translations:
-
Translations for updating/inserting WhatsApp templates specifications.
- destinations:
-
Destinations for updating/inserting WhatsApp templates specifications.
- sendOrder:
Example
{
"ID": "object",
"translations": [
{
"language": "string",
"body": "string"
}
],
"destinations": [
{
"phoneNumber": "string"
}
],
"sendOrder": "number"
}
UpsertWidgetInput: object
- brandID:
-
Brand ID to put this widget in.
- specs:
-
Specifications for upserting widgets input.
Example
{
"brandID": "object",
"specs": [
{
"ID": "object",
"content": "string",
"name": "string",
"order": "number",
"published": "boolean",
"region": "string"
}
]
}
UpsertWidgetSpec: object
- ID:
-
The ID of a widget to be updated/inserted. Omit this to create a new widget.
- content:
-
Content of the widget.
- name:
-
Name of the widget.
- order:
-
Order of the widget.
- published:
-
A flag to indicate whether the widget is published or not.
- region:
-
Region of the widget.
Example
{
"ID": "object",
"content": "string",
"name": "string",
"order": "number",
"published": "boolean",
"region": "string"
}
UserProfile: object
- basicInfo:
- addresses:
Example
{
"basicInfo": {
"email": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"phone": "string",
"dateOfBirth": "number"
},
"addresses": [
{
"addressLabel": "string",
"contactName": "string",
"districtCode": "string",
"street": "string",
"latitude": "string",
"longitude": "string",
"postalCode": "string",
"isPrimary": "boolean",
"salesChannel": "string"
}
]
}
ValidateSettingInput: object
- adminEmail:
-
Admin's email of the brand.
- bankAccount:
-
Bank account of the brand.
- checkoutAsGuestEnabled:
-
A flag to allow or disallow checkout as guest.
- confirmPaymentMessage:
-
Set the brand confirm payment message.
- faviconURL:
-
URL of the brand favicon.
- hideFromSearchEngine:
-
A flag to indicate whether this brand can be found from search engine or not.
- newsletter:
-
The brand's newsletter.
- paymentMethods:
-
The brand's payment methods.
- productFilterAndSort:
-
The brand's custom filter and sort.
- productOption:
-
The brand's product option.
- reviewsAndRatingEnabled:
-
A flag to allow or disallow reviews and rating.
- setAsMaintenance:
-
Set the current brand status as maintenance.
- socialMediaLink:
-
The brand's social media link.
- websiteDescription:
-
The brand's website description.
- websiteTitle:
-
The brand's website title.
- defaultExchangePointSettingID:
-
The exchange point setting for this brand.
- facebookAnalytics:
- googleAnalytics:
- privyID:
- googleAuth:
Example
{
"adminEmail": "string",
"bankAccount": {
"banks": [
{
"name": "string",
"accountNumber": "string",
"accountName": "string",
"isActive": "boolean"
}
]
},
"checkoutAsGuestEnabled": "boolean",
"confirmPaymentMessage": {
"isActive": "boolean",
"message": "string"
},
"faviconURL": "string",
"hideFromSearchEngine": "boolean",
"newsletter": {
"popupOnFirstVisit": "boolean",
"content": "string"
},
"paymentMethods": {
"paymentMethods": [
{
"name": "string",
"merchantID": "string",
"clientKey": "string",
"serverKey": "string",
"acquiringBank": "string",
"payPalAccount": "string",
"specs": [
{
"method": "string",
"isActive": "boolean",
"chargeFeeToCustomer": "boolean",
"expiryHour": "number"
}
]
}
]
},
"productFilterAndSort": {
"filters": [
{
"name": "string",
"isActive": "boolean",
"type": "string",
"variantSpecs": [
{
"key": "string",
"translations": [
{
"language": "string",
"text": "string"
}
],
"options": [
{
"value": "string",
"translations": [
{
"language": "string",
"text": "string"
}
]
}
]
}
],
"tagSpec": {
"options": [
null
]
}
}
]
}
}
ValidationResult: object
- errorMessages:
Example
{
"errorMessages": [
{
"settingKey": "string",
"message": "string"
}
]
}
Variant: object
- SKU:
- optionValue:
- stock:
- attributes:
- channelAttributes:
- images:
Example
{
"SKU": "object",
"optionValue": [
{
"key": "object",
"value": "string"
}
],
"stock": "number",
"attributes": [
{
"sortIndex": "number",
"translations": [
{
"key": "object",
"value": "string",
"language": "string"
}
]
}
],
"channelAttributes": [
{
"channelID": "object",
"key": "object",
"value": "string"
}
],
"images": [
"string"
]
}
VariantAttribute: object
- sortIndex:
- translations:
Example
{
"sortIndex": "number",
"translations": [
{
"key": "object",
"value": "string",
"language": "string"
}
]
}
VariantBasePriceSpecInput: object
- SKU:
-
SKU of the variant.
- basePrices:
-
Base prices for variant base price specification.
Example
{
"SKU": "object",
"basePrices": [
{
"code": "string",
"value": "number"
}
]
}
VariantOption: object
- variant:
- key:
- keyLabel:
- value:
- valueLabel:
Example
{
"variant": {
"product": {
"ID": "object",
"brandID": "object",
"brand": {
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string",
"tenantID": "string",
"tenant": {
"ID": "object",
"name": "string",
"language": "string",
"currencyCode": "string",
"brands": {
"items": [
{
"ID": "string",
"name": "string"
}
]
}
}
}
]
}
}
}
]
}
}
}
]
}
}
}
}
}
}
VariantUpsertInput: object
- SKU:
- options:
-
Options for updating/inserting variant input.
- basePrices:
-
Base prices for updating/inserting variant input.
- channelIDs:
- attributes:
-
Attributes for updating.inserting variant input.
- channelAttributes:
-
Channel attributes for updating/inserting variant input.
- imageURLs:
- stock:
- ignoreStock:
Example
{
"SKU": "object",
"options": [
{
"key": "object",
"value": "string"
}
],
"basePrices": [
{
"code": "string",
"value": "number"
}
],
"channelIDs": [
"string"
],
"attributes": [
{
"sortIndex": "number",
"translations": [
{
"key": "string",
"value": "string",
"language": "string"
}
]
}
],
"channelAttributes": [
{
"channelID": "string",
"key": "object",
"value": "string"
}
],
"imageURLs": [
"string"
],
"stock": "number",
"ignoreStock": "boolean"
}
VariantWithStockUpsertInput: object
- SKU:
- options:
-
Options for updating/inserting variant input.
- basePrices:
-
Base prices for updating/inserting variant input.
- channelIDs:
- attributes:
-
Attributes for updating.inserting variant input.
- channelAttributes:
-
Channel attributes for updating/inserting variant input.
- imageURLs:
- stock:
- warehouseID:
-
specific warehouse for product to be upserted
- currentStock:
-
current sku stock
- ignoreCurrentStock:
-
ignore current stock.
set to 'true' to check the current stock in inventory and add / subtract based on 'stock' field
set to 'false' to set current stock as defined in 'stock' field
- ignoreStock:
-
ignore stock
set to 'true' to make stock always available set to 'false' then the stock depend on the quantity of product
Example
{
"SKU": "object",
"options": [
{
"key": "object",
"value": "string"
}
],
"basePrices": [
{
"code": "string",
"value": "number"
}
],
"channelIDs": [
"string"
],
"attributes": [
{
"sortIndex": "number",
"translations": [
{
"key": "string",
"value": "string",
"language": "string"
}
]
}
],
"channelAttributes": [
{
"channelID": "string",
"key": "object",
"value": "string"
}
],
"imageURLs": [
"string"
],
"stock": "number",
"warehouseID": "string",
"currentStock": "number",
"ignoreCurrentStock": "boolean",
"ignoreStock": "boolean"
}
VolumeInput: object
- length:
-
Length of the product.
- height:
-
Height of the product.
- width:
-
Width of the product.
- unit:
-
Unit for volume.
Example
{
"length": "number",
"height": "number",
"width": "number",
"unit": "string"
}
Warehouse: object
- warehouseID:
- tenantID:
- ID:
- address:
- isDefault:
Example
{
"warehouseID": "object",
"tenantID": "object",
"ID": "object",
"address": {
"phones": [
"string"
],
"emails": [
"string"
],
"districtCode": "string",
"street": "string",
"latitude": "number",
"longitude": "number",
"postalCode": "string",
"formattedAddress": "string"
},
"isDefault": "boolean"
}
WarehouseAddress: object
- phones:
- emails:
- districtCode:
- street:
- latitude:
- longitude:
- postalCode:
- formattedAddress:
Example
{
"phones": [
"string"
],
"emails": [
"string"
],
"districtCode": "string",
"street": "string",
"latitude": "number",
"longitude": "number",
"postalCode": "string",
"formattedAddress": "string"
}
WarehouseAddressInput: object
- phones:
-
Phone numbers for this address.
- emails:
-
Emails for this address.
- street:
-
Street name for this address.
- districtCode:
-
District code for this address.
- postalCode:
-
Postal code for this address.
- latitude:
-
This address' latitude.
- longitude:
-
This address' longitude.
Example
{
"phones": [
"string"
],
"emails": [
"string"
],
"street": "string",
"districtCode": "string",
"postalCode": "string",
"latitude": "number",
"longitude": "number"
}
WeightInput: object
- value:
-
Weight value of the product.
- unit:
-
Unit for weight.
Example
{
"value": "number",
"unit": "string"
}
WhatsAppTemplateInputV2: object
- buyer:
- isActive:
- seller:
Example
{
"buyer": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
},
"isActive": "boolean",
"seller": {
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
}
}
WhatsappTemplateSpecV2: object
- targetPhoneNumbers:
- translations:
Example
{
"targetPhoneNumbers": [
"string"
],
"translations": [
{
"language": "string",
"body": "string"
}
]
}
WidgetSortInput: object
- fieldName:
- isAscending:
Example
{
"fieldName": "string",
"isAscending": "boolean"
}
WidgetSpec: object
- region:
-
Region of the widget.
- order:
-
Order of the widget.
- name:
-
Name of the widget.
- content:
-
Content of the widget.
- published:
-
A flag to indicate whether the widget is published or not.
Example
{
"region": "string",
"order": "number",
"name": "string",
"content": "string",
"published": "boolean"
}
activateAccountInput: object
- IDs:
-
List of account IDs to be activated.
Example
{
"IDs": [
"object"
]
}
createAuthorizationCodeInput: object
- acessToken:
-
access token generated
- tenantID:
-
give authorization code for the given Tenant ID or the context (in authorization headers) if not given
- clientID:
-
the Client that generated the access token
Example
{
"acessToken": "string",
"tenantID": "string",
"clientID": "string"
}
deactivateAccountInput: object
- IDs:
-
List of account IDs to be deactivated.
Example
{
"IDs": [
"object"
]
}
message: object
- to:
- from:
- timestamp:
- buyer_name:
- message:
- id:
- message_id:
- gql_id:
- type:
- status:
- context_id:
- caption:
- meta:
- channel:
Example
{
"to": "string",
"from": "string",
"timestamp": "string",
"buyer_name": "string",
"message": "string",
"id": "object",
"message_id": "object",
"gql_id": "object",
"type": "string",
"status": "string",
"context_id": "string",
"caption": "string",
"meta": [
{
"gql_id": "string",
"key": "string",
"value": "string"
}
],
"channel": "string"
}
messageInput: object
- to:
- from:
- timestamp:
- buyer_name:
- message:
- message_id:
- gql_id:
- type:
- status:
- element_name:
- namespace:
- id:
- context_id:
- meta:
- caption:
- channel:
Example
{
"to": "string",
"from": "string",
"timestamp": "string",
"buyer_name": "string",
"message": "string",
"message_id": "object",
"gql_id": "object",
"type": "string",
"status": "string",
"element_name": "string",
"namespace": "string",
"id": "object",
"context_id": "string",
"meta": [
{
"gql_id": "string",
"key": "string",
"value": "string"
}
],
"caption": "string",
"channel": "string"
}
removeAccessTokenInput: object
- accessToken:
-
The result of access token creation.
Example
{
"accessToken": "string"
}
removeAdminsInput: object
- accountIDs:
-
List of Admin AccountIDs to be removed
Example
{
"accountIDs": [
"string"
]
}
search: object
- messages:
- buyers:
Example
{
"messages": [
{
"buyerName": "string",
"lastMessage": "string",
"message_id": "string",
"roomID": "string",
"id": "number",
"type": "string",
"channel": "string"
}
],
"buyers": [
{
"buyerName": "string",
"lastMessage": "string",
"message_id": "string",
"roomID": "string",
"id": "number",
"type": "string",
"channel": "string"
}
]
}
seller: object
- phoneNumber:
- whatsappNamespace:
- brandId:
- email:
- role:
- businessHours:
- settings:
- botMenus:
- storeSettings:
- quickReplies:
- queueCount:
- messageTemplates:
- buyersInputShow:
- users:
- buyer:
Example
{
"phoneNumber": "object",
"whatsappNamespace": "string",
"brandId": "string",
"email": "string",
"role": "string",
"businessHours": [
{
"day": "number",
"shortName": "string",
"longName": "string",
"openAt": "string",
"closeAt": "string",
"isOpen": "boolean"
}
],
"settings": {
"sellerId": "string",
"about": "string",
"photoUrl": "string",
"address": "string",
"description": "string",
"email": "string",
"vertical": "string",
"websites": [
"string"
]
},
"botMenus": [
{
"id": "object",
"parentsId": [
"string"
],
"title": "string",
"sequence": "number",
"root": "boolean",
"textResponse": "string",
"fileUrl": "string",
"type": "string"
}
],
"storeSettings": [
{
"key": "string",
"value": "string"
}
],
"quickReplies": [
{
"id": "number",
"key": "string",
"value": "string",
"status": "boolean",
"category": "string"
}
],
"queueCount": "number",
"messageTemplates": [
{
"sellerId": "string",
"id": "number",
"key": "string",
"value": "string",
"type": "string"
}
]
}
sendInvitationEmailInput: object
- accountIDs:
-
List of AccountIDs to be send invitation email
Example
{
"accountIDs": [
"string"
]
}
setAllChatSettingsInput: object
- sellerId:
- about:
- photoUrl:
- address:
- description:
- email:
- vertical:
- websites:
Example
{
"sellerId": "string",
"about": "string",
"photoUrl": "string",
"address": "string",
"description": "string",
"email": "string",
"vertical": "string",
"websites": [
"string"
]
}
setOrchestratorPaymentInput: object
- orderID:
-
The ID of the affected order.
- payment:
-
Payment for the order.
Example
{
"orderID": "string",
"payment": {
"provider": "string",
"service": "string"
}
}
upsertMessageTemplateInput: object
- sellerId:
- key:
- id:
- value:
- type:
- status:
- category:
- attachment:
- attachmentType:
Example
{
"sellerId": "string",
"key": "string",
"id": "number",
"value": "string",
"type": "string",
"status": "boolean",
"category": "string",
"attachment": "string",
"attachmentType": "string"
}
upsertMessageTemplatesInput: object
- sellerId:
- specs:
Example
{
"sellerId": "string",
"specs": [
{
"sellerId": "string",
"key": "string",
"id": "number",
"value": "string",
"type": "string",
"status": "boolean",
"category": "string",
"attachment": "string",
"attachmentType": "string"
}
]
}